Skip to main content

Interface: RenderRequest

ghostly-engine.RenderRequest

The source document and parameters that should be rendered.

Hierarchy​

Properties​

attachments​

• Optional attachments: boolean

Set to true if attachments, if any, should be generated as well.

Defined in​

ghostly-engine/src/engine.ts:88


contentType​

• contentType: string

The model's media type. Used when document is a string.

Defined in​

ghostly-engine/src/engine.ts:82


document​

• document: string | object

The model to render, as a string or embedded JSON object.

Defined in​

ghostly-engine/src/engine.ts:79


locale​

• Optional locale: string

The locale to use when rendering. Defaults to the EngineConfig locale.

Defined in​

ghostly-engine/src/engine.ts:91


timeZone​

• Optional timeZone: string

The time zone to use when rendering. Defaults to the EngineConfig time zone.

Defined in​

ghostly-engine/src/engine.ts:94


views​

• views: View<unknown>[]

What views to render.

Defined in​

ghostly-engine/src/engine.ts:85