Options
All
  • Public
  • Public/Protected
  • All
Menu

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

see

Renderer.EVENT_BEGIN

see

Renderer.EVENT_END

Hierarchy

Index

Constructors

constructor

Events

Static Readonly BEGIN

BEGIN: "beginRender" = "beginRender"

Triggered before the renderer starts rendering a project.

Static Readonly END

END: "endRender" = "endRender"

Triggered after the renderer has written all documents.

Properties

Readonly outputDirectory

outputDirectory: string

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

Readonly project

The project the renderer is currently processing.

Optional urls

urls?: UrlMapping<any>[]

A list of all pages that should be generated.

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

Accessors

isDefaultPrevented

  • get isDefaultPrevented(): boolean

isPropagationStopped

  • get isPropagationStopped(): boolean

name

  • get name(): string

Methods

preventDefault

  • preventDefault(): void

stopPropagation

  • stopPropagation(): void

Generated using TypeDoc