Class RendererEvent

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

See

Constructors

constructor

Properties

outputDirectory project urls?

Methods

createPageEvent

Events

BEGIN END

Constructors

constructor

Properties

ReadonlyoutputDirectory

outputDirectory: string

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

Readonlyproject

project: Models.ProjectReflection

The project the renderer is currently processing.

Optionalurls

urls?: UrlMapping<Models.Reflection>[]

A list of all pages that should be generated.

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

Methods

createPageEvent

Events

Static ReadonlyBEGIN

BEGIN = "beginRender"

Triggered before the renderer starts rendering a project.

Static ReadonlyEND

END = "endRender"

Triggered after the renderer has written all documents.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
Events