Class: Liquid

Hierarchy

  • Liquid

Constructors

constructor

+ new Liquid(opts: LiquidOptions): Liquid

Defined in liquid.ts:26

Parameters:

Name Type Default
opts LiquidOptions {}

Returns: Liquid

Properties

filters

• filters: FilterMap

Defined in liquid.ts:24

options

• options: NormalizedFullOptions

Defined in liquid.ts:21

parseFileImpl

• parseFileImpl: function

Defined in liquid.ts:26

Type declaration:

▸ (file: string, sync?: undefined | false | true): Iterator‹Template[]›

Parameters:

Name Type
file string
sync? undefined | false | true

parser

• parser: Parser

Defined in liquid.ts:23

renderer

• renderer: Render

Defined in liquid.ts:22

tags

• tags: TagMap

Defined in liquid.ts:25

Methods

_evalValue

▸ _evalValue(str: string, ctx: Context): IterableIterator‹any›

Defined in liquid.ts:105

Parameters:

Name Type
str string
ctx Context

Returns: IterableIterator‹any›

_parseAndRender

▸ _parseAndRender(html: string, scope?: undefined | object, sync?: undefined | false | true): IterableIterator‹any›

Defined in liquid.ts:60

Parameters:

Name Type
html string
scope? undefined | object
sync? undefined | false | true

Returns: IterableIterator‹any›

Private _parseFile

▸ _parseFile(file: string, sync?: undefined | false | true): IterableIterator‹Promise‹boolean› | Promise‹string› | Template[]›

Defined in liquid.ts:80

Parameters:

Name Type
file string
sync? undefined | false | true

Returns: IterableIterator‹Promise‹boolean› | Promise‹string› | Template[]›

Private _parseFileCached

▸ _parseFileCached(file: string, sync?: undefined | false | true): IterableIterator‹any›

Defined in liquid.ts:71

Parameters:

Name Type
file string
sync? undefined | false | true

Returns: IterableIterator‹any›

_render

▸ _render(tpl: Template[], scope?: undefined | object, sync?: undefined | false | true): IterableIterator‹any›

Defined in liquid.ts:45

Parameters:

Name Type
tpl Template[]
scope? undefined | object
sync? undefined | false | true

Returns: IterableIterator‹any›

evalValue

▸ evalValue(str: string, ctx: Context): Promise‹any›

Defined in liquid.ts:109

Parameters:

Name Type
str string
ctx Context

Returns: Promise‹any›

evalValueSync

▸ evalValueSync(str: string, ctx: Context): any

Defined in liquid.ts:112

Parameters:

Name Type
str string
ctx Context

Returns: any

express

▸ express(): (Anonymous function)

Defined in liquid.ts:125

Returns: (Anonymous function)

Private lookupError

▸ lookupError(file: string, roots: string[]): any

Defined in liquid.ts:149

Parameters:

Name Type
file string
roots string[]

Returns: any

Private lookupFiles

▸ lookupFiles(file: string, options: NormalizedFullOptions): IterableIterator‹string›

Defined in liquid.ts:138

Parameters:

Name Type
file string
options NormalizedFullOptions

Returns: IterableIterator‹string›

parse

▸ parse(html: string, filepath?: undefined | string): Template[]

Defined in liquid.ts:39

Parameters:

Name Type
html string
filepath? undefined | string

Returns: Template[]

parseAndRender

▸ parseAndRender(html: string, scope?: undefined | object): Promise‹any›

Defined in liquid.ts:64

Parameters:

Name Type
html string
scope? undefined | object

Returns: Promise‹any›

parseAndRenderSync

▸ parseAndRenderSync(html: string, scope?: undefined | object): any

Defined in liquid.ts:67

Parameters:

Name Type
html string
scope? undefined | object

Returns: any

parseFile

▸ parseFile(file: string): Promise‹Template[]›

Defined in liquid.ts:90

Parameters:

Name Type
file string

Returns: Promise‹Template[]›

parseFileSync

▸ parseFileSync(file: string): Template[]

Defined in liquid.ts:93

Parameters:

Name Type
file string

Returns: Template[]

plugin

▸ plugin(plugin: function): void

Defined in liquid.ts:122

Parameters:

▪ plugin: function

▸ (this: Liquid, L: Liquid): void

Parameters:

Name Type
this Liquid
L Liquid

Returns: void

registerFilter

▸ registerFilter(name: string, filter: FilterImplOptions): void

Defined in liquid.ts:116

Parameters:

Name Type
name string
filter FilterImplOptions

Returns: void

registerTag

▸ registerTag(name: string, tag: TagImplOptions): void

Defined in liquid.ts:119

Parameters:

Name Type
name string
tag TagImplOptions

Returns: void

render

▸ render(tpl: Template[], scope?: undefined | object): Promise‹any›

Defined in liquid.ts:49

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: Promise‹any›

renderFile

▸ renderFile(file: string, ctx?: undefined | object): Promise‹any›

Defined in liquid.ts:96

Parameters:

Name Type
file string
ctx? undefined | object

Returns: Promise‹any›

renderFileSync

▸ renderFileSync(file: string, ctx?: undefined | object): any

Defined in liquid.ts:100

Parameters:

Name Type
file string
ctx? undefined | object

Returns: any

renderSync

▸ renderSync(tpl: Template[], scope?: undefined | object): any

Defined in liquid.ts:52

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: any

renderToNodeStream

▸ renderToNodeStream(tpl: Template[], scope?: undefined | object): ReadableStream

Defined in liquid.ts:55

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: ReadableStream

Next