Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RendererEvent

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 BEGIN

BEGIN: string = "beginRender"

Triggered before the renderer starts rendering a project.

Static END

END: string = "endRender"

Triggered after the renderer has written all documents.

Properties

outputDirectory

outputDirectory: string

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

project

The project the renderer is currently processing.

settings

settings: any

The settings that have been passed to TypeDoc.

urls

urls: UrlMapping[]

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

createPageEvent

preventDefault

  • preventDefault(): void

stopPropagation

  • stopPropagation(): void

Generated using TypeDoc