Class Context

The context describes the current state the converter is in.

Constructors

constructor

new Context(converter, programs, project, scope?): Context
Internal
Create a new Context instance.
Parameters
- converter: Converter
  The converter instance that has created the context.
- programs: readonly Program[]
- project: Models.ProjectReflection
- scope: Models.Reflection = project
Returns Context
- Defined in converter/context.ts:89

Properties

`Readonly`converter

converter: Converter

The converter instance that has created the context.

convertingClassOrInterface

convertingClassOrInterface: boolean = false

convertingTypeNode

convertingTypeNode: boolean = false

`Readonly`programs

programs: readonly Program[]

All programs being converted.

`Readonly`project

project: Models.ProjectReflection

The project that is currently processed.

`Readonly`scope

scope: Models.Reflection

The scope or parent reflection that is currently processed.

shouldBeStatic

shouldBeStatic: boolean = false

Accessors

checker

get checker(): TypeChecker
The TypeChecker instance returned by the TypeScript compiler.

Returns TypeChecker
- Defined in converter/context.ts:40

i18n

get i18n(): TranslationProxy
Translation interface for log messages.

Returns TranslationProxy
- Defined in converter/context.ts:47

logger

get logger(): Logger
Internal
Returns Logger
- Defined in converter/context.ts:103

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
- Defined in converter/context.ts:55

Methods

addChild

addChild(reflection): void
Parameters
- reflection: Models.DeclarationReflection | Models.DocumentReflection
Returns void
- Defined in converter/context.ts:244

createDeclarationReflection

createDeclarationReflection(kind, symbol, exportSymbol, nameOverride?): Models.DeclarationReflection
Parameters
- kind: ReflectionKind
- symbol: undefined | Symbol
- exportSymbol: undefined | Symbol
- OptionalnameOverride: string
Returns Models.DeclarationReflection
- Defined in converter/context.ts:166

expectSymbolAtLocation

expectSymbolAtLocation(node): Symbol
Parameters
- node: Node
Returns Symbol
- Defined in converter/context.ts:146

finalizeDeclarationReflection

finalizeDeclarationReflection(reflection): void
Parameters
- reflection: Models.DeclarationReflection
Returns void
- Defined in converter/context.ts:232

getComment

getComment(symbol, kind): undefined | Models.Comment
Parameters
- symbol: Symbol
- kind: ReflectionKind
Returns undefined | Models.Comment
- Defined in converter/context.ts:270

getFileComment

getFileComment(node): undefined | Models.Comment
Parameters
- node: SourceFile
Returns undefined | Models.Comment
- Defined in converter/context.ts:292

getJsDocComment

getJsDocComment(declaration): undefined | Models.Comment
Parameters
- declaration:
      | JSDocTemplateTag
      | JSDocPropertyLikeTag
      | JSDocTypedefTag
      | JSDocCallbackTag
      | JSDocEnumTag
Returns undefined | Models.Comment
- Defined in converter/context.ts:302

getNodeComment

getNodeComment(node, moduleComment): undefined | Models.Comment
Parameters
- node: Node
- moduleComment: boolean
Returns undefined | Models.Comment
- Defined in converter/context.ts:281

getSignatureComment

getSignatureComment(declaration): undefined | Models.Comment
Parameters
- declaration: JSDocSignature | SignatureDeclaration
Returns undefined | Models.Comment
- Defined in converter/context.ts:319

getSymbolAtLocation

getSymbolAtLocation(node): undefined | Symbol
Parameters
- node: Node
Returns undefined | Symbol
- Defined in converter/context.ts:138

getTypeAtLocation

getTypeAtLocation(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.
- Defined in converter/context.ts:113

postReflectionCreation

postReflectionCreation(reflection, symbol, exportSymbol): void
Parameters
- reflection: Models.Reflection
- symbol: undefined | Symbol
- exportSymbol: undefined | Symbol
Returns void
- Defined in converter/context.ts:192

registerReflection

registerReflection(reflection, 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: Models.Reflection
  The reflection that should be registered.
- symbol: undefined | Symbol
  The symbol the given reflection was resolved from.
Returns void
- Defined in converter/context.ts:261

resolveAliasedSymbol

resolveAliasedSymbol(symbol): Symbol
Parameters
- symbol: Symbol
Returns Symbol
- Defined in converter/context.ts:162

setActiveProgram

setActiveProgram(program): void
Internal
Parameters
- program: undefined | Program
Returns void
- Defined in converter/context.ts:266

shouldIgnore

shouldIgnore(symbol): boolean
Parameters
- symbol: Symbol
Returns boolean
- Defined in converter/context.ts:250

withScope

withScope(scope): Context
Parameters
- scope: Models.Reflection
Returns Context
- Defined in converter/context.ts:331