Return the application / root component instance.
InternalcommentInternalexcludeInternalexcludeInternalexcludeInternalexcludeInternalexternalInternalexternalInternalmaxReturn the owner of this component.
InternalpreserveInternalvalidationStatic ReadonlyEVENT_Triggered when the converter begins converting a project. The listener will be given a Context object.
Static ReadonlyEVENT_Triggered when the converter has created a declaration reflection. The listener will be given Context and a Models.DeclarationReflection.
Static ReadonlyEVENT_Triggered when the converter has created a document reflection.
The listener will be given undefined (for consistency with the
other create events) and a Models.DocumentReflection.
Static ReadonlyEVENT_Triggered when the converter has created a parameter reflection.
The listener will be given Context, Models.ParameterReflection and a ts.Node?
Static ReadonlyEVENT_Triggered when the converter has created a project reflection. The listener will be given Context and a Models.ProjectReflection.
Static ReadonlyEVENT_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 ReadonlyEVENT_Triggered when the converter has created a type parameter reflection. The listener will be given Context and a Models.TypeParameterReflection
Static ReadonlyEVENT_Triggered when the converter has finished converting a project. The listener will be given a Context object.
Static ReadonlyEVENT_Triggered when the converter resolves a reflection. The listener will be given Context and a Reflection.
Static ReadonlyEVENT_Triggered when the converter begins resolving a project. The listener will be given Context.
Static ReadonlyEVENT_Triggered when the converter has finished resolving a project. The listener will be given Context.
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.
Compile the given source files and create a project reflection for them.
Finalize deferred conversion, must be called by the caller of permitDeferredConversion
InternalStops listening to an event.
the event to stop listening to.
the function to remove from the listener array.
Starts listening to an event.
the event to listen to.
function to be called when an this event is emitted.
optional priority to insert this hook with.
Parse the given file into a comment. Intended to be used with markdown files.
Permit deferred conversion steps to take place. Until this is called, deferConversion will throw if used.
InternalInternalUsed 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.
Emits an event to all currently subscribed listeners.
the event to emit.
any arguments required for the event.
Compiles source files using TypeScript and converts compiler symbols to reflections.