Class Converter

Compiles source files using TypeScript and converts compiler symbols to reflections.

Hierarchy

ChildableComponent<Application, ConverterComponent, ConverterEvents>
- Converter

Constructors

constructor

new Converter(owner): Converter
Parameters
- owner: Application
Returns Converter
Overrides ChildableComponent< Application, ConverterComponent, ConverterEvents >.constructor
- Defined in converter/converter.ts:229

Properties

componentName

componentName: string

The name of this component as set by the @Component decorator.

Accessors

application

get application(): Application
Return the application / root component instance.

Returns Application
Inherited from ChildableComponent.application
- Defined in utils/component.ts:128

`Internal`commentStyle

commentStyle: any

config

get config(): CommentParserConfig
Returns CommentParserConfig
- Defined in converter/converter.ts:146

`Internal`excludeExternals

excludeExternals: any

`Internal`excludeNotDocumented

excludeNotDocumented: any

`Internal`excludePrivate

excludePrivate: any

`Internal`excludeProtected

excludeProtected: any

`Internal`excludeReferences

excludeReferences: any

`Internal`externalPattern

externalPattern: any

`Internal`externalSymbolLinkMappings

externalSymbolLinkMappings: any

`Internal`maxTypeConversionDepth

maxTypeConversionDepth: any

owner

get owner(): O
Return the owner of this component.

Returns O
Inherited from ChildableComponent.owner
- Defined in utils/component.ts:138

`Internal`preserveLinkText

preserveLinkText: any

`Internal`validation

validation: any

Methods

addComponent

addComponent<T>(name, componentClass): T
Type Parameters
- T extends ConverterComponent
Parameters
- name: string
- componentClass: T | ComponentClass<T, Application>
Returns T
Inherited from ChildableComponent.addComponent
- Defined in utils/component.ts:186

addProjectDocuments

addProjectDocuments(project): void
Internal
Parameters
- project: Models.ProjectReflection
Returns void
- Defined in converter/converter.ts:306

addUnknownSymbolResolver

addUnknownSymbolResolver(resolver): void
Adds a new resolver that the theme can use to try to figure out how to link to a symbol declared by a third-party library which is not included in the documentation.

The resolver function will be passed a declaration reference which it can attempt to resolve. If resolution fails, the function should return undefined.

Note: This will be used for both references to types declared in node_modules (in which case the reference passed will have the moduleSource set and the symbolReference will navigate via .) and user defined {@link} tags which cannot be resolved. If the link being resolved is inferred from a type, then no part will be passed to the resolver function.
Parameters
- resolver: ExternalSymbolResolver
Returns void
- Defined in converter/converter.ts:375

convert

convert(entryPoints): Models.ProjectReflection
Compile the given source files and create a project reflection for them.
Parameters
- entryPoints: readonly DocumentationEntryPoint[]
Returns Models.ProjectReflection
- Defined in converter/converter.ts:281

convertSymbol

convertSymbol(context, symbol, exportSymbol?): void
Internal
Parameters
- context: Context
- symbol: Symbol
- OptionalexportSymbol: Symbol
Returns void
- Defined in converter/converter.ts:328

convertType

convertType(context, node): Models.SomeType
Internal
Convert the given TypeScript type into its TypeDoc type reflection.
Parameters
- context: Context
  The context object describing the current state the converter is in.
- node: undefined | TypeNode | Type
Returns Models.SomeType
The TypeDoc type reflection representing the given node and type.
- Defined in converter/converter.ts:343

getComponent

getComponent(name): undefined | ConverterComponent
Retrieve a plugin instance.
Parameters
- name: string
Returns undefined | ConverterComponent
The instance of the plugin or undefined if no plugin with the given class is attached.
Inherited from ChildableComponent.getComponent
- Defined in utils/component.ts:178

getComponents

getComponents(): ConverterComponent[]
Returns ConverterComponent[]
Inherited from ChildableComponent.getComponents
- Defined in utils/component.ts:182

`Protected`initialize

initialize(): void
Initialize this component.

Returns void
Inherited from ChildableComponent.initialize
- Defined in utils/component.ts:121

isExternal

isExternal(symbol): boolean
Internal
Parameters
- symbol: Symbol
Returns boolean
- Defined in converter/converter.ts:583

off

off<K>(event, listener): void
Stops listening to an event.
Type Parameters
- K extends keyof ConverterEvents
Parameters
- event: K
  the event to stop listening to.
- listener: ((this: undefined, ...args: ConverterEvents[K]) => void)
  the function to remove from the listener array.
  - - (this, ...args): void
    - Parameters
      this: undefined
      Rest...args: ConverterEvents[K]
      Returns void
Returns void
Inherited from ChildableComponent.off
- Defined in utils/events.ts:41

on

on<K>(event, listener, priority?): void
Starts listening to an event.
Type Parameters
- K extends keyof ConverterEvents
Parameters
- event: K
  the event to listen to.
- listener: ((this: undefined, ...args: ConverterEvents[K]) => void)
  function to be called when an this event is emitted.
  - - (this, ...args): void
    - Parameters
      this: undefined
      Rest...args: ConverterEvents[K]
      Returns void
- priority: number = 0
  optional priority to insert this hook with.
Returns void
Inherited from ChildableComponent.on
- Defined in utils/events.ts:26

parseRawComment

parseRawComment(file, files): {
content: Models.CommentDisplayPart[];
frontmatter: Record<string, unknown>;
}
Parse the given file into a comment. Intended to be used with markdown files.
Parameters
- file: MinimalSourceFile
- files: Models.FileRegistry
Returns {
content: Models.CommentDisplayPart[];
frontmatter: Record<string, unknown>;
}
- content: Models.CommentDisplayPart[]
- frontmatter: Record<string, unknown>
- Defined in converter/converter.ts:353

processDocumentTags

processDocumentTags(reflection, parent): void
Parameters
- reflection: Models.Reflection
- parent: Models.ContainerReflection
Returns void
- Defined in converter/converter.ts:592

resolveExternalLink

resolveExternalLink(ref, refl, part, symbolId): undefined | string | ExternalResolveResult
Internal
Parameters
- ref: DeclarationReference
- refl: Models.Reflection
- part: undefined | Models.CommentDisplayPart
- symbolId: undefined | Models.ReflectionSymbolId
Returns undefined | string | ExternalResolveResult
- Defined in converter/converter.ts:380

resolveLinks

resolveLinks(comment, owner): void
Parameters
- comment: Models.Comment
- owner: Models.Reflection
Returns void
- Defined in converter/converter.ts:392
resolveLinks(parts, owner): Models.CommentDisplayPart[]
Parameters
- parts: readonly Models.CommentDisplayPart[]
- owner: Models.Reflection
Returns Models.CommentDisplayPart[]
- Defined in converter/converter.ts:393

shouldIgnore

shouldIgnore(symbol): boolean
Internal
Used to determine if we should immediately bail when creating a reflection. Note: This should not be used for excludeNotDocumented because we don't have enough information at this point since comment discovery hasn't happened.
Parameters
- symbol: Symbol
Returns boolean
- Defined in converter/converter.ts:563

trigger

trigger<K>(event, ...args): void
Emits an event to all currently subscribed listeners.
Type Parameters
- K extends keyof ConverterEvents
Parameters
- event: K
  the event to emit.
- Rest...args: ConverterEvents[K]
  any arguments required for the event.
Returns void
Inherited from ChildableComponent.trigger
- Defined in utils/events.ts:59

Events

`Static` `Readonly`EVENT_BEGIN

EVENT_BEGIN: "begin" = ConverterEvents.BEGIN

Triggered when the converter begins converting a project. The listener will be given a Context object.

`Static` `Readonly`EVENT_CREATE_DECLARATION

EVENT_CREATE_DECLARATION: "createDeclaration" = ConverterEvents.CREATE_DECLARATION

Triggered when the converter has created a declaration reflection. The listener will be given Context and a Models.DeclarationReflection.

`Static` `Readonly`EVENT_CREATE_PARAMETER

EVENT_CREATE_PARAMETER: "createParameter" = ConverterEvents.CREATE_PARAMETER

Triggered when the converter has created a parameter reflection. The listener will be given Context, Models.ParameterReflection and a ts.Node?

`Static` `Readonly`EVENT_CREATE_SIGNATURE

EVENT_CREATE_SIGNATURE: "createSignature" = ConverterEvents.CREATE_SIGNATURE

Triggered when the converter has created a signature reflection. The listener will be given Context, Models.SignatureReflection | Models.ProjectReflection the declaration, ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined, and ts.Signature | undefined. The signature will be undefined if the created signature is an index signature.

`Static` `Readonly`EVENT_CREATE_TYPE_PARAMETER

EVENT_CREATE_TYPE_PARAMETER: "createTypeParameter" = ConverterEvents.CREATE_TYPE_PARAMETER

Triggered when the converter has created a type parameter reflection. The listener will be given Context and a Models.TypeParameterReflection

`Static` `Readonly`EVENT_END

EVENT_END: "end" = ConverterEvents.END

Triggered when the converter has finished converting a project. The listener will be given a Context object.

`Static` `Readonly`EVENT_RESOLVE

EVENT_RESOLVE: "resolveReflection" = ConverterEvents.RESOLVE

Triggered when the converter resolves a reflection. The listener will be given Context and a Reflection.

`Static` `Readonly`EVENT_RESOLVE_BEGIN

EVENT_RESOLVE_BEGIN: "resolveBegin" = ConverterEvents.RESOLVE_BEGIN

Triggered when the converter begins resolving a project. The listener will be given Context.

`Static` `Readonly`EVENT_RESOLVE_END

EVENT_RESOLVE_END: "resolveEnd" = ConverterEvents.RESOLVE_END

Triggered when the converter has finished resolving a project. The listener will be given Context.

Class Converter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns Converter

Properties

componentName

Accessors

application

Returns Application

InternalcommentStyle

config

Returns CommentParserConfig

InternalexcludeExternals

InternalexcludeNotDocumented

InternalexcludePrivate

InternalexcludeProtected

InternalexcludeReferences

InternalexternalPattern

InternalexternalSymbolLinkMappings

InternalmaxTypeConversionDepth

owner

Returns O

InternalpreserveLinkText

Internalvalidation

Methods

addComponent

Type Parameters

Parameters

Returns T

addProjectDocuments

Parameters

Returns void

addUnknownSymbolResolver

Parameters

Returns void

convert

Parameters

Returns Models.ProjectReflection

convertSymbol

Parameters

Returns void

convertType

Parameters

Returns Models.SomeType

getComponent

Parameters

Returns undefined | ConverterComponent

getComponents

Returns ConverterComponent[]

Protectedinitialize

Returns void

isExternal

Parameters

Returns boolean

off

Type Parameters

Parameters

Parameters

Returns void

Returns void

on

Type Parameters

Parameters

Parameters

Returns void

Returns void

parseRawComment

Parameters

Returns { content: Models.CommentDisplayPart[]; frontmatter: Record<string, unknown>; }

content: Models.CommentDisplayPart[]

frontmatter: Record<string, unknown>

processDocumentTags

`Internal`commentStyle

`Internal`excludeExternals

`Internal`excludeNotDocumented

`Internal`excludePrivate

`Internal`excludeProtected

`Internal`excludeReferences

`Internal`externalPattern

`Internal`externalSymbolLinkMappings

`Internal`maxTypeConversionDepth

`Internal`preserveLinkText

`Internal`validation

`Protected`initialize

Returns {
content: Models.CommentDisplayPart[];
frontmatter: Record<string, unknown>;
}

`Static` `Readonly`EVENT_BEGIN

`Static` `Readonly`EVENT_CREATE_DECLARATION

`Static` `Readonly`EVENT_CREATE_PARAMETER

`Static` `Readonly`EVENT_CREATE_SIGNATURE

`Static` `Readonly`EVENT_CREATE_TYPE_PARAMETER

`Static` `Readonly`EVENT_END

`Static` `Readonly`EVENT_RESOLVE

`Static` `Readonly`EVENT_RESOLVE_BEGIN

`Static` `Readonly`EVENT_RESOLVE_END