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.
Due for deprecation in 0.29, use the reference to this on ProjectReflection, this was the wrong place for this member to live.
Internationalization module which supports translating according to
the lang option.
The renderer used to generate the HTML documentation output.
InternalrepositoriesCache of git repository information used by the SourcePlugin to get source URLs.
Will be undefined before convert is called, will also be undefined if the
--disableSources option is enabled.
The serializer used to generate JSON output.
Static ReadonlyVERSIONThe version number of TypeDoc.
Return the application / root component instance.
InternalentryInternalentryInternallangReturn the owner of this component.
InternalskipRun the converter for the given set of files and return the generated reflections.
An instance of ProjectReflection on success, undefined otherwise.
Run a convert / watch process.
Callback to run after each convert, receiving the project
True if the watch process should be restarted due to a configuration change, false for an options error
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.
Render outputs selected with options for the specified project
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.
Return the path to the TypeScript compiler.
Conversion is synchronous to ensure that TypeDoc builds are completely reproducible, so the SourcePlugin, which needs git information either needs to run commands synchronously or we need to initialize the repositories which are relevant before calling Converter#convert. As of v0.28.20, we do that initialization early.
This generally does not need to be called manually as convert and convertAndWatch will automatically do it, but is exposed for API users who want to primarily run TypeDoc synchronously.
Stops 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.
Optionalpriority: number
optional priority to insert this hook with. Higher priority is placed earlier in the listener array.
Print the version number.
Emits an event to all currently subscribed listeners.
the event to emit.
any arguments required for the event.
Register that the current build depends on a file, so that in watch mode the build will be repeated. Has no effect if a watch build is not running, or if the file has already been registered.
The file to watch. It does not need to exist, and you should in fact register files you look for, but which do not exist, so that if they are created the build will re-run. (e.g. if you look through a list of 5 possibilities and find the third, you should register the first 3.)
OptionalshouldRestart: boolean
Should the build be completely restarted? (This is normally only used for configuration files -- i.e. files whose contents determine how conversion, rendering, or compiling will be done, as opposed to files that are only read during the conversion or rendering.)
StaticbootstrapInitialize TypeDoc without loading plugins.
Optionaloptions: TypeDocOptions
Options to set during initialization
Optionalreaders: readonly OptionsReader[]
Option readers to use to discover options from config files.
StaticbootstrapInitialize TypeDoc, loading plugins if applicable.
Optionaloptions: TypeDocOptionsOptionalreaders: readonly OptionsReader[]Static ReadonlyEVENT_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 ReadonlyEVENT_Emitted just before outputs are generated. This can be used by plugins which generate additional auxiliary output files to avoid generating output if the user has validation warnings and treat warnings as errors is enabled.
Static ReadonlyEVENT_Emitted just after outputs are generated. This can be used by plugins which generate additional auxiliary output files to avoid generating output if the user has validation warnings and treat warnings as errors is enabled.
Static ReadonlyEVENT_Emitted after a project has been deserialized from JSON. The listener will be given an instance of ProjectReflection.
Static ReadonlyEVENT_Emitted when validation is being run. The listener will be given an instance of ProjectReflection.
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.
Remarks
Access to an Application instance can be retrieved with Application.bootstrap or Application.bootstrapWithPlugins. It can not be constructed manually.