Options
All
  • Public
  • Public/Protected
  • All
Menu

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

see

Renderer.EVENT_BEGIN_PAGE

see

Renderer.EVENT_END_PAGE

Type parameters

  • Model = unknown

Hierarchy

Index

Constructors

constructor

  • new PageEvent<Model>(name: string): PageEvent<Model>

Events

Static Readonly BEGIN

BEGIN: "beginPage" = "beginPage"

Triggered before a document will be rendered.

Static Readonly END

END: "endPage" = "endPage"

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

Properties

Optional contents

contents?: string

The final html content of this page.

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

filename

filename: string

The filename the page will be written to.

model

model: Model

The model that should be rendered on this page.

project

The project the renderer is currently processing.

template

template: RenderTemplate<PageEvent<Model>>

The template that should be used to render this page.

url

url: string

The url this page will be located at.

Accessors

isDefaultPrevented

  • get isDefaultPrevented(): boolean

isPropagationStopped

  • get isPropagationStopped(): boolean

name

  • get name(): string

Methods

preventDefault

  • preventDefault(): void

stopPropagation

  • stopPropagation(): void

Generated using TypeDoc