Class Context

The context describes the current state the converter is in.

Constructors

Properties

converter: Converter

The converter instance that has created the context.

convertingClassOrInterface: boolean = false
convertingTypeNode: boolean = false
programs: readonly Program[]

All programs being converted.

The project that is currently processed.

The scope or parent reflection that is currently processed.

shouldBeStatic: boolean = false

Accessors

  • get program(): Program
  • The program currently being converted. Accessing this property will throw if a source file is not currently being converted.

    Returns Program

Methods

  • Return the type declaration of the given node.

    Parameters

    • node: Node

      The TypeScript node whose type should be resolved.

    Returns undefined | Type

    The type declaration of the given node.

  • Register a newly generated reflection. All created reflections should be passed to this method to ensure that the project helper functions work correctly.

    Parameters

    • reflection: Models.Reflection

      The reflection that should be registered.

    • symbol: undefined | Symbol

      The symbol the given reflection was resolved from.

    Returns void

  • Trigger a node reflection event.

    All events are dispatched on the current converter instance.

    Parameters

    • name: string

      The name of the event that should be triggered.

    • reflection: Models.Reflection

      The triggering reflection.

    • Optional node: Node

      The triggering TypeScript node if available.

    Returns void

Generated using TypeDoc