Class Context

Readonlyconverter

convertingClassOrInterface

convertingTypeNode

inlineType

preventInline

Readonlyprograms

Readonlyproject

Readonlyscope

shouldBeStatic

checker

• get checker(): TypeChecker

  The TypeChecker instance returned by the TypeScript compiler.

  Returns 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

addChild

• addChild(reflection: DocumentReflection | DeclarationReflection): void

  Parameters

  • reflection: DocumentReflection | DeclarationReflection

  Returns void

createDeclarationReflection

• createDeclarationReflection(
      kind: ReflectionKind,
      symbol: Symbol | undefined,
      exportSymbol: Symbol | undefined,
      nameOverride?: string,
  ): DeclarationReflection

  Parameters

  • kind: ReflectionKind
  • symbol: Symbol | undefined
  • exportSymbol: Symbol | undefined
  • OptionalnameOverride: string

  Returns DeclarationReflection

createSymbolId

• createSymbolId(symbol: Symbol, declaration?: Declaration): ReflectionSymbolId

  Create a stable ReflectionSymbolId for the provided symbol, optionally targeting a specific declaration.

  Parameters

  • symbol: Symbol
  • Optionaldeclaration: Declaration

  Returns ReflectionSymbolId

createSymbolReference

• createSymbolReference(
      symbol: Symbol,
      context: Context,
      name?: string,
  ): ReferenceType

  Create a ReferenceType which points to the provided symbol.

  Parameters

  • symbol: Symbol
  • context: Context
  • Optionalname: string

  Returns ReferenceType

expectSymbolAtLocation

• expectSymbolAtLocation(node: Node): Symbol

  Parameters

  • node: Node

  Returns Symbol

finalizeDeclarationReflection

• finalizeDeclarationReflection(reflection: DeclarationReflection): void

  Parameters

  • reflection: DeclarationReflection

  Returns void

getComment

• getComment(symbol: Symbol, kind: ReflectionKind): Comment | undefined

  Parameters

  • symbol: Symbol
  • kind: ReflectionKind

  Returns Comment | undefined

getFileComment

• getFileComment(node: SourceFile): Comment | undefined

  Parameters

  • node: SourceFile

  Returns Comment | undefined

getJsDocComment

• getJsDocComment(
      declaration:
          | JSDocPropertyLikeTag
          | JSDocCallbackTag
          | JSDocTypedefTag
          | JSDocTemplateTag
          | JSDocEnumTag,
  ): Comment
  | undefined

  Parameters

  • declaration:
        | JSDocPropertyLikeTag
        | JSDocCallbackTag
        | JSDocTypedefTag
        | JSDocTemplateTag
        | JSDocEnumTag

  Returns Comment | undefined

getNodeComment

• getNodeComment(node: Node, moduleComment: boolean): Comment | undefined

  Parameters

  • node: Node
  • moduleComment: boolean

  Returns Comment | undefined

getReflectionFromSymbol

• getReflectionFromSymbol(symbol: Symbol): Reflection | undefined

  Parameters

  • symbol: Symbol

  Returns Reflection | undefined

getSignatureComment

• getSignatureComment(
      declaration: SignatureDeclaration | JSDocSignature,
  ): Comment | undefined

  Parameters

  • declaration: SignatureDeclaration | JSDocSignature

  Returns Comment | undefined

getSymbolAtLocation

• getSymbolAtLocation(node: Node): Symbol | undefined

  Parameters

  • node: Node

  Returns Symbol | undefined

getSymbolFromReflection

• getSymbolFromReflection(reflection: Reflection): Symbol | undefined

  Parameters

  • reflection: Reflection

  Returns Symbol | undefined

getTypeAtLocation

• getTypeAtLocation(node: Node): Type | undefined

  Return the type declaration of the given node.

  Parameters

  • node: Node

    The TypeScript node whose type should be resolved.

  Returns Type | undefined

  The type declaration of the given node.

postReflectionCreation

• postReflectionCreation(
      reflection: Reflection,
      symbol: Symbol | undefined,
      exportSymbol: Symbol | undefined,
  ): void

  Parameters

  • reflection: Reflection
  • symbol: Symbol | undefined
  • exportSymbol: Symbol | undefined

  Returns void

registerReflection

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

    The symbol the given reflection was resolved from.

  • OptionalfilePath: NormalizedPath

  Returns void

resolveAliasedSymbol

• resolveAliasedSymbol(symbol: Symbol): Symbol

  Parameters

  • symbol: Symbol

  Returns Symbol

shouldIgnore

• shouldIgnore(symbol: Symbol): boolean

  Parameters

  • symbol: Symbol

  Returns boolean

shouldInline

• shouldInline(symbol: Symbol, name: string): boolean

  Parameters

  • symbol: Symbol
  • name: string

  Returns boolean

withScope

• withScope(scope: Reflection): Context

  Parameters

  • scope: Reflection

  Returns Context