The name of this component as set by the @Component decorator.
The converter used to create the declaration reflections.
The deserializer used to restore previously serialized JSON output.
The logger that should be used to output messages.
The renderer used to generate the documentation output.
The serializer used to generate JSON output.
Static Readonly EVENT_Emitted after plugins have been loaded and options have been read, but before they have been frozen. The listener will be given an instance of Application.
Static Readonly EVENT_Emitted after a project has been deserialized from JSON. The listener will be given an instance of ProjectReflection.
Static Readonly EVENT_Emitted when validation is being run. The listener will be given an instance of ProjectReflection.
Static VERSIONThe version number of TypeDoc.
Return the application / root component instance.
Internal entryInternal entryReturn the owner of this component.
Internal skipProtected bubbleRun the converter for the given set of files and return the generated reflections.
An instance of ProjectReflection on success, undefined otherwise.
Render HTML for the given project
Write the reflections to a json file.
The path and file name of the target file.
Whether the JSON file could be written successfully.
Retrieve a plugin instance.
The instance of the plugin or undefined if no plugin with the given class is attached.
Gets the entry points to be documented according to the current entryPoints and entryPointStrategy options.
May return undefined if entry points fail to be expanded.
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: anyTell 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).
Static bootstrapInitialize TypeDoc without loading plugins.
Options to set during initialization
Option readers to use to discover options from config files.
Initialize the application with pretty-printing output disabled.
const app = Application.bootstrap({ pretty: false });
Static bootstrapInitialize TypeDoc, loading plugins if applicable.
The default TypeDoc main application class.
This class holds the two main components of TypeDoc, the Converter and the Renderer. When running TypeDoc, first the Converter is invoked which generates a ProjectReflection from the passed in source files. The ProjectReflection is a hierarchical model representation of the TypeScript project. Afterwards the model is passed to the Renderer which uses an instance of Theme to generate the final documentation.
Both the Converter and the Renderer emit a series of events while processing the project. Subscribe to these Events to control the application flow or alter the output.