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

See

Hierarchy

Constructors

Properties

outputDirectory: string

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

The project the renderer is currently processing.

urls?: UrlMapping<any>[]

A list of all pages that should be generated.

This list can be altered during the EVENT_BEGIN event.

Events

BEGIN: "beginRender" = "beginRender"

Triggered before the renderer starts rendering a project.

END: "endRender" = "endRender"

Triggered after the renderer has written all documents.

Accessors

  • get isDefaultPrevented(): boolean
  • Has preventDefault been called?

    Returns boolean

  • get isPropagationStopped(): boolean
  • Has stopPropagation been called?

    Returns boolean

  • get name(): string
  • Return the event name.

    Returns string

Methods

  • Internal

    Create an PageEvent event based on this event and the given url mapping.

    Returns

    A newly created PageEvent instance.

    Type Parameters

    • Model

    Parameters

    Returns PageEvent<Model>

  • preventDefault(): void
  • Prevent the default action associated with this event from being executed.

    Returns void

  • stopPropagation(): void
  • Stop the propagation of this event. Remaining event handlers will not be executed.

    Returns void

Generated using TypeDoc