Options
All
  • Public
  • Public/Protected
  • All
Menu

The context describes the current state the converter is in.

Hierarchy

  • Context

Index

Properties

Readonly converter

converter: Converter

The converter instance that has created the context.

Readonly programs

programs: readonly Program[]

All programs being converted.

Readonly project

The project that is currently processed.

Readonly scope

scope: Reflection

The scope or parent reflection that is currently processed.

Accessors

checker

  • get checker(): TypeChecker

program

  • 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

addChild

createDeclarationReflection

expectSymbolAtLocation

  • expectSymbolAtLocation(node: Node): Symbol

finalizeDeclarationReflection

  • finalizeDeclarationReflection(reflection: DeclarationReflection, symbol: undefined | Symbol, exportSymbol?: Symbol, commentNode?: Node): void

getCompilerOptions

  • getCompilerOptions(): CompilerOptions

getSymbolAtLocation

  • getSymbolAtLocation(node: Node): undefined | Symbol

getTypeAtLocation

  • getTypeAtLocation(node: Node): undefined | Type
  • 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.

registerReflection

  • registerReflection(reflection: Reflection, symbol: undefined | Symbol): void
  • 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: Reflection

      The reflection that should be registered.

    • symbol: undefined | Symbol

      The symbol the given reflection was resolved from.

    Returns void

resolveAliasedSymbol

  • resolveAliasedSymbol(symbol: Symbol): Symbol

shouldIgnore

  • shouldIgnore(symbol: Symbol): boolean

trigger

  • trigger(name: string, reflection: Reflection, node?: Node): 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: Reflection

      The triggering reflection.

    • Optional node: Node

      The triggering TypeScript node if available.

    Returns void

withScope

Generated using TypeDoc