Create new Component instance.
The name of this component as set by the
decorator.
The human readable name of the project. Used within the templates to set the title of the document.
Internal validationStatic Readonly EVENT_Triggered when the converter begins converting a project. The listener will be given a Context object.
Static Readonly EVENT_Triggered when the converter has created a declaration reflection. The listener will be given Context and a DeclarationReflection.
Static Readonly EVENT_Triggered when the converter has created a parameter reflection.
The listener will be given Context, ParameterReflection and a ts.Node?
Static Readonly EVENT_Triggered when the converter has created a signature reflection.
The listener will be given Context, SignatureReflection | ProjectReflection and
ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined
Static Readonly EVENT_Triggered when the converter has created a type parameter reflection. The listener will be given Context and a TypeParameterReflection
Static Readonly EVENT_Triggered when the converter has finished converting a project. The listener will be given a Context object.
Static Readonly EVENT_Triggered when the converter resolves a reflection. The listener will be given Context and a Reflection.
Static Readonly EVENT_Triggered when the converter begins resolving a project. The listener will be given Context.
Static Readonly EVENT_Triggered when the converter has finished resolving a project. The listener will be given Context.
Return the application / root component instance.
Return the owner of this component.
Protected bubbleCompile the given source files and create a project reflection for them.
Internal
Convert the given TypeScript type into its TypeDoc type reflection.
The TypeDoc type reflection representing the given node and type.
The context object describing the current state the converter is in.
Protected initializeInversion-of-control versions of on. Tell this object to listen to
an event in another object... keeping track of what it's listening to
for easier unbinding later.
Optional callback: EventCallbackOptional priority: numberInversion-of-control versions of once.
Optional priority: numberRemove one or many callbacks. If context is null, removes all
callbacks with that function. If callback is null, removes all
callbacks for the event. If name is null, removes all bound
callbacks for all events.
Optional context: anyOptional callback: EventCallbackOptional context: anyBind an event to a callback function. Passing "all" will bind
the callback to all events fired.
Optional context: anyOptional callback: EventCallbackOptional context: anyOptional priority: numberOptional context: anyOptional priority: numberBind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.
Optional context: anyOptional context: anyOptional priority: anyParse the given file into a comment. Intended to be used with markdown files.
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.
Tell this object to stop listening to either specific events ... or to every object it's currently listening to.
Optional obj: EventDispatcherOptional name: string | EventMapOptional callback: EventCallbackTrigger one or many events, firing all bound callbacks. Callbacks are
passed the same arguments as trigger is, apart from the event name
(unless you're listening on "all", which will cause your callback to
receive the true name of the event as the first argument).
Generated using TypeDoc
Compiles source files using TypeScript and converts compiler symbols to reflections.