Module: ghostly-engine

Classes

• Engine
• GhostlyError
• WSResponse

Interfaces

• EngineConfig
• RenderRequest
• RenderResult
• TemplateConfig
• TemplateEngine
• View
• WSErrorResponse
• WSRenderRequest
• WSRenderResult

Type aliases

HTMLTransform

Ƭ HTMLTransform: "identity" | "inline" | "noscript" | "sanitize" | "minimize"

An operation to apply to the HTML view before returning the result.

• identity: Do nothing.
• inline: Inlines external resources for all element which have an ghostly-inline attribute or URL query parameter. The attribute/parameter may optionally include a comma-separated list of operations to apply to the inlined resource (default is all current transforms).
• noscript: Removes all script elements (unless attribute 'ghostly-noscript' is set to 'false').
• sanitize: Removes all scripts or otherwise dangerous markup/XSS using DOMPurify (way more strict than 'noscript'!).
• minimize: Minifies the HTML and CSS.

Defined in

ghostly-runtime/build/src/types.d.ts:110

---

OnGhostlyEvent

Ƭ OnGhostlyEvent: (event: object) => void

Type declaration

▸ (event): void

Parameters

Name	Type
event	object

Returns

void

Defined in

ghostly-runtime/build/src/types.d.ts:98

---

PaperFormat

Ƭ PaperFormat: "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "Letter" | "Legal" | "Tabloid" | "Ledger"

Defined in

ghostly-runtime/build/src/types.d.ts:111

---

PaperSize

Ƭ PaperSize: Object

Type declaration

Name	Type
format?	PaperFormat
orientation?	"portrait" | "landscape"

Defined in

ghostly-runtime/build/src/types.d.ts:112

---

ViewportSize

Ƭ ViewportSize: Object

Type declaration

Name	Type
height?	number
width?	number

Defined in

ghostly-runtime/build/src/types.d.ts:116

---

WSRenderResponse

Ƭ WSRenderResponse: WSRenderResult[]

The HTTP response message.

Defined in

ghostly-engine/src/engine.ts:104