Class: Liquid

Hierarchy

  • Liquid

Constructors

constructor

+ new Liquid(opts: LiquidOptions): Liquid

Defined in liquid.ts:25

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

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:92

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:56

Parameters:

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

Returns: IterableIterator‹any›

_parseLayoutFile

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

Defined in liquid.ts:70

Parameters:

Name Type
file string
sync? undefined | false | true
currentFile? undefined | string

Returns: Iterator‹Template[]›

_parsePartialFile

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

Defined in liquid.ts:67

Parameters:

Name Type
file string
sync? undefined | false | true
currentFile? undefined | string

Returns: Iterator‹Template[]›

_render

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

Defined in liquid.ts:41

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:96

Parameters:

Name Type
str string
ctx Context

Returns: Promise‹any›

evalValueSync

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

Defined in liquid.ts:99

Parameters:

Name Type
str string
ctx Context

Returns: any

express

▸ express(): (Anonymous function)

Defined in liquid.ts:112

Returns: (Anonymous function)

parse

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

Defined in liquid.ts:37

Parameters:

Name Type
html string
filepath? undefined | string

Returns: Template[]

parseAndRender

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

Defined in liquid.ts:60

Parameters:

Name Type
html string
scope? undefined | object

Returns: Promise‹any›

parseAndRenderSync

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

Defined in liquid.ts:63

Parameters:

Name Type
html string
scope? undefined | object

Returns: any

parseFile

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

Defined in liquid.ts:73

Parameters:

Name Type
file string

Returns: Promise‹Template[]›

parseFileSync

▸ parseFileSync(file: string): Template[]

Defined in liquid.ts:76

Parameters:

Name Type
file string

Returns: Template[]

plugin

▸ plugin(plugin: function): void

Defined in liquid.ts:109

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:103

Parameters:

Name Type
name string
filter FilterImplOptions

Returns: void

registerTag

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

Defined in liquid.ts:106

Parameters:

Name Type
name string
tag TagImplOptions

Returns: void

render

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

Defined in liquid.ts:45

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: Promise‹any›

renderFile

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

Defined in liquid.ts:79

Parameters:

Name Type
file string
ctx? undefined | object

Returns: Promise‹any›

renderFileSync

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

Defined in liquid.ts:83

Parameters:

Name Type
file string
ctx? undefined | object

Returns: any

renderFileToNodeStream

▸ renderFileToNodeStream(file: string, scope?: undefined | object): Promise‹ReadableStream›

Defined in liquid.ts:87

Parameters:

Name Type
file string
scope? undefined | object

Returns: Promise‹ReadableStream›

renderSync

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

Defined in liquid.ts:48

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: any

renderToNodeStream

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

Defined in liquid.ts:51

Parameters:

Name Type
tpl Template[]
scope? undefined | object

Returns: ReadableStream

Next