Class Template<T>

A template that can be used to render HTML content.

Type Parameters

T extends TemplateParams = void
The type of the template's params.

Hierarchy (view full)

Template
- RootTemplate

Index

Constructors

Properties

Methods

render renderString stringifyContent

Constructors

constructor

new Template<T>(content): Template<T>
Creates a new template.
Type Parameters
- T extends TemplateParams = void
Parameters
- content: TemplateContent | ((params) => TemplateContent | Promise<TemplateContent>)
  The content of the template, or a function that returns the content.
Returns Template<T>
- Defined in template.ts:29

Properties

`Readonly` content

content: TemplateContent | ((params) => TemplateContent | Promise<TemplateContent>)

The content of the template, or a function that returns the content.

Type declaration

- (params): TemplateContent | Promise<TemplateContent>
- Parameters
  - params: T
  Returns TemplateContent | Promise<TemplateContent>

Methods

render

render(params): Promise<RawContent>
Renders the template with the given params (if content is a function).
Parameters
- params: T
  The params to pass to the template.
Returns Promise<RawContent>
The rendered template as a RawContent instance.
- Defined in template.ts:48

renderString

renderString(params): Promise<string>
Renders the template with the given params (if content is a function).
Parameters
- params: T
  The params to pass to the template.
Returns Promise<string>
The rendered template.
- Defined in template.ts:38

`Private` stringifyContent

stringifyContent(child?): string
Returns the HTML string representation of a child of the template.
Parameters
- Optional child: TagChild<any>
  The child to stringify.
Returns string
The HTML string representation of the child.
- Defined in template.ts:57

Generated using TypeDoc