Skip to main content

Interface: WSRenderRequest

ghostly-engine.WSRenderRequest

The HTTP request message.

Hierarchy​

Properties​

attachments​

β€’ Optional attachments: boolean

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

Inherited from​

RenderRequest.attachments

Defined in​

ghostly-engine/src/engine.ts:88


contentType​

β€’ contentType: string

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

Inherited from​

RenderRequest.contentType

Defined in​

ghostly-engine/src/engine.ts:82


document​

β€’ document: string | object

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

Inherited from​

RenderRequest.document

Defined in​

ghostly-engine/src/engine.ts:79


locale​

β€’ Optional locale: string

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

Inherited from​

RenderRequest.locale

Defined in​

ghostly-engine/src/engine.ts:91


template​

β€’ template: string

URL to the template to use.

Defined in​

ghostly-engine/src/engine.ts:100


timeZone​

β€’ Optional timeZone: string

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

Inherited from​

RenderRequest.timeZone

Defined in​

ghostly-engine/src/engine.ts:94


views​

β€’ views: View<unknown>[]

What views to render.

Inherited from​

RenderRequest.views

Defined in​

ghostly-engine/src/engine.ts:85