Class Application

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.

Hierarchy

Constructors

Properties

componentName: string

The name of this component as set by the

Component

decorator.

converter: Converter

The converter used to create the declaration reflections.

logger: Logger

The logger that should be used to output messages.

loggerType: string | Function
options: Options
renderer: Renderer

The renderer used to generate the documentation output.

serializer: Serializer

The serializer used to generate JSON output.

skipErrorChecking: boolean
EVENT_BOOTSTRAP_END: string = ApplicationEvents.BOOTSTRAP_END

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 and the Partial passed to bootstrap.

VERSION: string = packageInfo.version

The version number of TypeDoc.

Accessors

Methods

  • Type Parameters

    Parameters

    • name: string
    • componentClass: T | ComponentClass<T, Application>

    Returns T

  • Run the converter for the given set of files and write the reflections to a json file.

    Returns

    Whether the JSON file could be written successfully.

    Parameters

    Returns Promise<void>

  • Retrieve a plugin instance.

    Returns

    The instance of the plugin or undefined if no plugin with the given class is attached.

    Parameters

    • name: string

    Returns undefined | AbstractComponent<Application>

  • Parameters

    • name: string

    Returns boolean

  • 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.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns Application

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns Application

  • 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).

    Parameters

    Returns Application

Generated using TypeDoc