Interface CustomPartialOptions

Options for cjs.registerCustomPartial. Only createNode is required.

interface CustomPartialOptions {
    createNode(this: CustomPartialOptions, ...args: any[]): unknown;
    destroyNode?(this: CustomPartialOptions, node: Node): void;
    onAdd?(this: CustomPartialOptions, node: Node, ...args: any[]): void;
    onRemove?(this: CustomPartialOptions, node: Node): void;
    pause?(this: CustomPartialOptions, node: Node): void;
    resume?(this: CustomPartialOptions, node: Node): void;
}

Index

Methods

createNode destroyNode? onAdd? onRemove? pause? resume?

Methods

createNode

createNode(this: CustomPartialOptions, ...args: any[]): unknown
Returns a new DOM node every time the partial is used (called with the partial's arguments).
Parameters
- this: CustomPartialOptions
- ...args: any[]
Returns unknown
- Defined in template/template.ts:51

`Optional`destroyNode

destroyNode?(this: CustomPartialOptions, node: Node): void
Called when the template is destroyed (usually with cjs.destroyTemplate).
Parameters
- this: CustomPartialOptions
- node: Node
Returns void
- Defined in template/template.ts:61

`Optional`onAdd

onAdd?(this: CustomPartialOptions, node: Node, ...args: any[]): void
Called when the node is added to the DOM tree (with the node and the partial's arguments).
Parameters
- this: CustomPartialOptions
- node: Node
- ...args: any[]
Returns void
- Defined in template/template.ts:53

`Optional`onRemove

onRemove?(this: CustomPartialOptions, node: Node): void
Called when the node is removed from the DOM tree.
Parameters
- this: CustomPartialOptions
- node: Node
Returns void
- Defined in template/template.ts:55

`Optional`pause

pause?(this: CustomPartialOptions, node: Node): void
Called when the template is paused (usually with cjs.pauseTemplate).
Parameters
- this: CustomPartialOptions
- node: Node
Returns void
- Defined in template/template.ts:57

`Optional`resume

resume?(this: CustomPartialOptions, node: Node): void
Called when the template is resumed (usually with cjs.resumeTemplate).
Parameters
- this: CustomPartialOptions
- node: Node
Returns void
- Defined in template/template.ts:59