An event emitted by the Renderer class before and after the markup of a page is rendered.


Type Parameters

  • Model = unknown



  • new PageEvent<Model>(name: string): PageEvent<Model>
  • Create a new Event instance.

    Type Parameters

    • Model = unknown


    • name: string

    Returns PageEvent<Model>


contents?: string

The final html content of this page.

Should be rendered by layout templates and can be modified by plugins.

filename: string

The filename the page will be written to.

model: Model

The model that should be rendered on this page.

The project the renderer is currently processing.

template: RenderTemplate<PageEvent<Model>>

The template that should be used to render this page.

url: string

The url this page will be located at.


BEGIN: "beginPage" = "beginPage"

Triggered before a document will be rendered.

END: "endPage" = "endPage"

Triggered after a document has been rendered, just before it is written to disc.


  • 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


  • 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