Skip to main content

Abstract Class: TemplateLoader

Defined in: src/loader.ts:43

The abstract base class for all template loaders.

A template loader is responsible for finding template source text given a name or identifier.

Extended by​

Constructors​

Constructor​

new TemplateLoader(): TemplateLoader

Returns​

TemplateLoader

Methods​

getSource()​

abstract getSource(env, name, context?, options?): Promise<TemplateSource>

Defined in: src/loader.ts:53

Load template source text and meta data.

Parameters​

env​

Environment

The active template environment.

name​

string

A name or identifier for the target template.

context?​

RenderContext

The current render context, if one is available.

options?​

Record<string, unknown>

Arbitrary options that can be used to narrow the template search space.

Returns​

Promise<TemplateSource>

getSourceSync()​

abstract getSourceSync(env, name, context?, options?): TemplateSource

Defined in: src/loader.ts:64

A synchronous version of getSource.

Parameters​

env​

Environment

name​

string

context?​

RenderContext

options?​

Record<string, unknown>

Returns​

TemplateSource

See​

getSource

load()​

load(env, name, globals?, context?, options?): Promise<Template>

Defined in: src/loader.ts:75

Used internally by Environment.parse(). Delegates to getSource.

Parameters​

env​

Environment

name​

string

globals?​

Namespace

context?​

RenderContext

options?​

Record<string, unknown>

Returns​

Promise<Template>

See​

getSource. Override load to implement a caching loader.

loadSync()​

loadSync(env, name, globals?, context?, options?): Template

Defined in: src/loader.ts:95

A synchronous version of load.

Parameters​

env​

Environment

name​

string

globals?​

Namespace

context?​

RenderContext

options?​

Record<string, unknown>

Returns​

Template

See​

load