Create new Component instance.
The name of this component as set by the @Component decorator.
Hooks which will be called when rendering pages. Note:
See RendererHooks for a description of each available hook, and when it will be called.
A 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 Renderer.render call.
A list of async jobs which must be completed before rendering output. They will be called after RendererEvent.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 Renderer.render call.
OptionalthemeThe theme that is used to render the documentation.
Return the application / root component instance.
InternalcacheReturn the owner of this component.
ProtectedinitializeStops listening to an event.
the event to stop listening to.
the function to remove from the listener array.
Rest...args: RendererEvents[K]Starts listening to an event.
the event to listen to.
function to be called when an this event is emitted.
Rest...args: RendererEvents[K]optional priority to insert this hook with.
Render 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.
Emits an event to all currently subscribed listeners.
the event to emit.
Rest...args: RendererEvents[K]any arguments required for the event.
Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_Static ReadonlyEVENT_
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.
Renderer.EVENT_BEGIN
Triggered before the renderer starts rendering a project. The listener receives an instance of RendererEvent.
Renderer.EVENT_BEGIN_PAGE
Triggered before a document will be rendered. The listener receives an instance of PageEvent. By calling PageEvent.preventDefault the generation of the document can be canceled.
Renderer.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 PageEvent.preventDefault the the document will not be saved to disc.
Renderer.EVENT_END
Triggered after the renderer has written all documents. The listener receives an instance of RendererEvent.
Renderer.EVENT_PREPARE_INDEX
Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive an instance of IndexEvent.