Create new Component instance.
Internal cacheInternal cleanInternal cnameThe name of this component as set by the @Component decorator.
Internal darkInternal githubHooks which will be called when rendering pages. Note:
See RendererHooks for a description of each available hook, and when it will be called.
Internal lightA list of async jobs which must be completed after rendering output files but before generation is considered successful. These functions will be called after all documents have been written to the filesystem.
This may be used by plugins to register work that must be done to finalize output files. For example: asynchronously generating an image referenced in a render hook.
Note: This array is cleared after calling the contained functions on each render call.
A list of async jobs which must be completed before rendering output. They will be called after BEGIN has fired, but before any files have been written.
This may be used by plugins to register work that must be done to prepare output files. For example: asynchronously transform markdown to HTML.
Note: This array is cleared after calling the contained functions on each render call.
Internal prettyInternal themeOptional themeThe theme that is used to render the documentation.
Return the application / root component instance.
Return the owner of this component.
Protected bubbleProtected 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: anyRender the given project reflection to the specified output directory.
The project that should be rendered.
The path of the directory the documentation should be rendered to.
Tell 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 Readonly EVENT_Static Readonly EVENT_Static Readonly EVENT_Static Readonly EVENT_Static Readonly EVENT_Generated using TypeDoc
The renderer processes a ProjectReflection using a Theme instance and writes the emitted html documents to a output directory. You can specify which theme should be used using the
--theme <name>command line argument.Renderer is a subclass of EventDispatcher and triggers a series of events while a project is being processed. You can listen to these events to control the flow or manipulate the output.
EVENT_BEGIN
Triggered before the renderer starts rendering a project. The listener receives an instance of RendererEvent. By calling preventDefault the entire render process can be canceled.
EVENT_BEGIN_PAGE
Triggered before a document will be rendered. The listener receives an instance of PageEvent. By calling preventDefault the generation of the document can be canceled.
EVENT_END_PAGE
Triggered after a document has been rendered, just before it is written to disc. The listener receives an instance of PageEvent. When calling preventDefault the the document will not be saved to disc.
EVENT_END
Triggered after the renderer has written all documents. The listener receives an instance of RendererEvent.
EVENT_PREPARE_INDEX
Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive an instance of IndexEvent.