Class RendererEvent

An event emitted by the Renderer class at the very beginning and ending of the entire rendering process.

Hierarchy (view full)

Constructors

Properties

outputDirectory: string

The path of the directory the documentation should be written to.

The project the renderer is currently processing.

A list of all pages that should be generated.

This list can be altered during the Renderer.EVENT_BEGIN event.

Accessors

Methods

Events

BEGIN: "beginRender" = "beginRender"

Triggered before the renderer starts rendering a project.

END: "endRender" = "endRender"

Triggered after the renderer has written all documents.

Generated using TypeDoc