Class: TemplateDriver
ghostly-runtime.TemplateDriver
Helper class to invoke the defined protocol methods using a user-defined sendMessage implementation.
Hierarchy
TemplateDriver
Implements
Constructors
constructor
• new TemplateDriver()
Properties
_template
• Protected Optional _template: string
Defined in
ghostly-runtime/src/driver.ts:5
Methods
ghostlyEnd
▸ ghostlyEnd(): Promise<void>
This optional method is invoked when all processing of the model is done. May be used to purge caches and other resources.
Returns
Promise<void>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:54
ghostlyFetch
▸ ghostlyFetch(info): Promise<GhostlyTypes>
Asks the template to render an attachment. This call should not return or resolve until the attachment is stable and fully rendered.
Parameters
| Name | Type |
|---|---|
info | AttachmentInfo<unknown> |
Returns
Promise<GhostlyTypes>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:39
ghostlyInit
▸ ghostlyInit(model): Promise<undefined | ModelInfo>
Used to supply the model (data) that the template should render from.
Parameters
| Name | Type |
|---|---|
model | Model |
Returns
Promise<undefined | ModelInfo>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:12
ghostlyLoad
▸ ghostlyLoad(template): Promise<void>
This optional method will be invoked once the template has been loaded by the browser, or each time the fragment part (hash) changes in a cached template.
Parameters
| Name | Type |
|---|---|
template | string |
Returns
Promise<void>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:7
ghostlyPreview
▸ ghostlyPreview(command?): Promise<PreviewResult>
This method is used by the PreviewDriver to print and to find out the preferred size of the IFrame.
Parameters
| Name | Type |
|---|---|
command | PreviewCommand |
Returns
Promise<PreviewResult>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:43
ghostlyRender
▸ ghostlyRender(view): Promise<GhostlyTypes>
Asks the template to render a specific view. This call should not return or resolve until the view is stable and fully rendered.
Parameters
| Name | Type |
|---|---|
view | View<unknown> |
Returns
Promise<GhostlyTypes>
Implementation of
Defined in
ghostly-runtime/src/driver.ts:35
sendMessage
▸ Protected Abstract sendMessage(request): Promise<GhostlyTypes>
Abstract method that must be provided by subclasses. Should send the request to the template, wait for response and then unpack and return the result.
Parameters
| Name | Type | Description |
|---|---|---|
request | GhostlyRequest | The raw request to send. |
Returns
Promise<GhostlyTypes>
The unpacked response.