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 [[BaseTheme]] to generate the final documentation.
Both the Converter and the Renderer are subclasses of the [[AbstractComponent]] and emit a series of events while processing the project. Subscribe to these Events to control the application flow or alter the output.
Create a new TypeDoc application instance.
The name of this component as set by the @Component decorator.
The converter used to create the declaration reflections.
The logger that should be used to output messages.
The renderer used to generate the documentation output.
The serializer used to generate JSON output.
The version number of TypeDoc.
A unique id that identifies this instance.
Return the application / root component instance.
Return the owner of this component.
Initialize TypeDoc with the given options object.
The desired options to set.
Run the converter for the given set of files and return the generated reflections.
An instance of ProjectReflection on success, undefined otherwise.
Expand a list of input files.
Searches for directories in the input files list and replaces them with a
listing of all TypeScript files within them. One may use the
to filter out files with a pattern.
The list of files that should be expanded.
The list of input files with expanded directories.
Render HTML for the given project
Run the converter for the given set of files and 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.
Converts a list of file-oriented paths in to DocumentationEntryPoints for conversion.
This is in contrast with the package-oriented
The list of filepaths that should be expanded.
The DocumentationEntryPoints corresponding to all the found entry points
Return the path to the TypeScript compiler.
Initialize this component.
Remove 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.
Bind an event to a
callback function. Passing
"all" will bind
the callback to all events fired.
Bind 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.
Print the version number.
Trigger 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