An object containing the options that should be used.
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.
Return the application / root component instance.
Return the owner of this component.
Run TypeDoc from the command line.
Run the converter for the given set of files and return the generated reflections.
A list of source that should be compiled and converted.
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 --exclude option
to filter out files with a pattern.
The list of files that should be expanded.
The list of input files with expanded directories.
Run the documentation generator for the given set of files.
A list of source files whose documentation should be generated.
The path the documentation should be written to.
TRUE if the documentation could be generated successfully, otherwise FALSE.
Run the documentation generator for the given set of files.
The project the documentation should be generated for.
The path the documentation should be written to.
TRUE if the documentation could be generated successfully, otherwise FALSE.
Run the converter for the given set of files and write the reflections to a json file.
A list of source that should be compiled and converted.
The path and file name of the target file.
TRUE if the json file could be written successfully, otherwise FALSE.
Run the converter for the given set of files and write the reflections to a json file.
The project that should be converted.
The path and file name of the target file.
TRUE if the json file could be written successfully, otherwise FALSE.
Retrieve a plugin instance.
The instance of the plugin or undefined if no plugin with the given class is attached.
Return all option declarations emitted by this component.
Return the path to the TypeScript compiler.
Initialize this component.
Inversion-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.
Inversion-of-control versions of once.
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.
Tell this object to stop listening to either specific events ... or to every object it's currently listening to.
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
Create a new TypeDoc application instance.