Class: Environment

Defined in: src/environment.ts:173

Template engine configuration from which templates can be loaded and parsed.

Constructors

Constructor

new Environment(options?): Environment

Defined in: src/environment.ts:208

Parameters

options?

EnvironmentOptions

Returns

Environment

Properties

autoEscape

autoEscape: boolean

Defined in: src/environment.ts:174

---

bufferFactory

bufferFactory: BufferFactory

Defined in: src/environment.ts:176

---

filters

filters: Record<string, Filter>

Defined in: src/environment.ts:178

---

globals

globals: Namespace | undefined

Defined in: src/environment.ts:180

---

lexer

lexer: _Lexer = LegacyLexer

Defined in: src/environment.ts:182

---

loader

loader: TemplateLoader

Defined in: src/environment.ts:184

---

maxAssignScore?

optional maxAssignScore?: number

Defined in: src/environment.ts:186

---

maxAssignScoreCumulative?

optional maxAssignScoreCumulative?: number

Defined in: src/environment.ts:188

---

maxContextDepth

maxContextDepth: number

Defined in: src/environment.ts:190

---

maxRenderScore?

optional maxRenderScore?: number

Defined in: src/environment.ts:192

---

maxRenderScoreCumulative?

optional maxRenderScoreCumulative?: number

Defined in: src/environment.ts:194

---

maxRenderSize?

optional maxRenderSize?: number

Defined in: src/environment.ts:196

---

parser

parser: _Parser = LegacyParser

Defined in: src/environment.ts:198

---

persistentRegisters

persistentRegisters: Set<string | symbol>

Defined in: src/environment.ts:200

---

strictFilters

strictFilters: boolean

Defined in: src/environment.ts:202

---

tags

tags: Record<string, Tag>

Defined in: src/environment.ts:204

---

undefinedType

undefinedType: _Undefined

Defined in: src/environment.ts:206

Methods

contains()

contains(left, right, context, token): boolean

Defined in: src/environment.ts:229

Parameters

left

unknown

right

unknown

context

RenderContext

token

Token

Returns

boolean

---

getTemplate()

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

Defined in: src/environment.ts:276

Parameters

name

string

globals?

Namespace

context?

RenderContext

options?

Record<string, unknown>

Returns

Promise<Template>

---

getTemplateSync()

getTemplateSync(name, globals?, context?, options?): Template

Defined in: src/environment.ts:285

Parameters

name

string

globals?

Namespace

context?

RenderContext

options?

Record<string, unknown>

Returns

Template

---

isEqual()

isEqual(left, right, context, token): boolean

Defined in: src/environment.ts:294

Parameters

left

unknown

right

unknown

context

RenderContext

token

Token

Returns

boolean

---

isLessThan()

isLessThan(left, right, context, token): boolean

Defined in: src/environment.ts:339

Parameters

left

unknown

right

unknown

context

RenderContext

token

Token

Returns

boolean

---

isNil()

isNil(obj): boolean

Defined in: src/environment.ts:387

Parameters

obj

unknown

Returns

boolean

---

isTruthy()

isTruthy(obj, context): boolean

Defined in: src/environment.ts:396

Parameters

obj

unknown

context

RenderContext

Returns

boolean

---

makeGlobals()

makeGlobals(namespace?): Namespace | undefined

Defined in: src/environment.ts:407

Return a new namespace combining environment globals and namespace.

Parameters

namespace?

Namespace

Returns

Namespace | undefined

---

parse()

parse(source, globals?, meta?): Template

Defined in: src/environment.ts:418

Parse template source code source into a new template.

If globals is given, pin that namespace to the resulting template.

Parameters

source

string

globals?

Namespace

meta?

TemplateMeta

Returns

Template

---

render()

render(source, data?): Promise<string>

Defined in: src/environment.ts:431

Parse and render template source code source with variables from data.

Parameters

source

string

data?

Record<string, unknown>

Returns

Promise<string>

---

renderSync()

renderSync(source, data?): string

Defined in: src/environment.ts:441

Parse and render template source code source with variables from data.

Parameters

source

string

data?

Record<string, unknown>

Returns

string

---

serialize()

serialize(obj, context, token): string

Defined in: src/environment.ts:448

Stringify obj suitable to output.

Parameters

obj

unknown

context

RenderContext

token

Token

Returns

string

---

setupFilters()

setupFilters(): void

Defined in: src/environment.ts:462

Returns

void

---

setupTags()

setupTags(): void

Defined in: src/environment.ts:527

Returns

void

---

toArray()

toArray(obj, context, token): unknown[]

Defined in: src/environment.ts:552

Parameters

obj

unknown

context

RenderContext

token

Token

Returns

unknown[]

---

toInteger()

toInteger(obj, context, token): number

Defined in: src/environment.ts:562

Parameters

obj

unknown

context

RenderContext

token

Token

Returns

number

---

toNumber()

toNumber(obj, context, token): number

Defined in: src/environment.ts:581

Parameters

obj

unknown

context

RenderContext

token

Token

Returns

number

---

toString()

toString(obj, context, token): string

Defined in: src/environment.ts:588

Parameters

obj

unknown

context

RenderContext

token

Token

Returns

string

---

trim()

trim(value, left?, right?): string

Defined in: src/environment.ts:612

Parameters

value

string

left?

string

right?

string

Returns

string