Class: Liquid

Hierarchy

  • Liquid

Constructors

constructor

+ new Liquid(opts: LiquidOptions): Liquid

Defined in src/liquid.ts:26

Parameters:

Name Type Default
opts LiquidOptions {}

Returns: Liquid

Properties

Readonly filters

• filters: FilterMap

Defined in src/liquid.ts:25

Readonly options

• options: NormalizedFullOptions

Defined in src/liquid.ts:22

Readonly parser

• parser: Parser

Defined in src/liquid.ts:24

Readonly renderer

• renderer: Render

Defined in src/liquid.ts:23

Readonly tags

• tags: TagMap

Defined in src/liquid.ts:26

Methods

_evalValue

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

Defined in src/liquid.ts:93

Parameters:

Name Type
str string
ctx Context

Returns: IterableIterator‹any›

_parseAndRender

▸ _parseAndRender(html: string, scope: object | undefined, renderOptions: RenderOptions): IterableIterator‹any›

Defined in src/liquid.ts:57

Parameters:

Name Type
html string
scope object | undefined
renderOptions RenderOptions

Returns: IterableIterator‹any›

_parseLayoutFile

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

Defined in src/liquid.ts:71

Parameters:

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

Returns: Generator‹unknown, Template[], string | Template[]›

_parsePartialFile

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

Defined in src/liquid.ts:68

Parameters:

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

Returns: Generator‹unknown, Template[], string | Template[]›

_render

▸ _render(tpl: Template[], scope: object | undefined, renderOptions: RenderOptions): IterableIterator‹any›

Defined in src/liquid.ts:42

Parameters:

Name Type
tpl Template[]
scope object | undefined
renderOptions RenderOptions

Returns: IterableIterator‹any›

evalValue

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

Defined in src/liquid.ts:97

Parameters:

Name Type
str string
ctx Context

Returns: Promise‹any›

evalValueSync

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

Defined in src/liquid.ts:100

Parameters:

Name Type
str string
ctx Context

Returns: any

express

▸ express(): (Anonymous function)

Defined in src/liquid.ts:113

Returns: (Anonymous function)

parse

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

Defined in src/liquid.ts:38

Parameters:

Name Type
html string
filepath? undefined | string

Returns: Template[]

parseAndRender

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

Defined in src/liquid.ts:61

Parameters:

Name Type
html string
scope? undefined | object
renderOptions? RenderOptions

Returns: Promise‹any›

parseAndRenderSync

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

Defined in src/liquid.ts:64

Parameters:

Name Type
html string
scope? undefined | object
renderOptions? RenderOptions

Returns: any

parseFile

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

Defined in src/liquid.ts:74

Parameters:

Name Type
file string

Returns: Promise‹Template[]›

parseFileSync

▸ parseFileSync(file: string): Template[]

Defined in src/liquid.ts:77

Parameters:

Name Type
file string

Returns: Template[]

plugin

▸ plugin(plugin: function): void

Defined in src/liquid.ts:110

Parameters:

▪ plugin: function

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

Parameters:

Name Type
this Liquid
L typeof Liquid

Returns: void

registerFilter

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

Defined in src/liquid.ts:104

Parameters:

Name Type
name string
filter FilterImplOptions

Returns: void

registerTag

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

Defined in src/liquid.ts:107

Parameters:

Name Type
name string
tag TagImplOptions

Returns: void

render

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

Defined in src/liquid.ts:46

Parameters:

Name Type
tpl Template[]
scope? undefined | object
renderOptions? RenderOptions

Returns: Promise‹any›

renderFile

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

Defined in src/liquid.ts:80

Parameters:

Name Type
file string
ctx? undefined | object
renderOptions? RenderOptions

Returns: Promise‹any›

renderFileSync

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

Defined in src/liquid.ts:84

Parameters:

Name Type
file string
ctx? undefined | object
renderOptions? RenderOptions

Returns: any

renderFileToNodeStream

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

Defined in src/liquid.ts:88

Parameters:

Name Type
file string
scope? undefined | object
renderOptions? RenderOptions

Returns: Promise‹ReadableStream‹››

renderSync

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

Defined in src/liquid.ts:49

Parameters:

Name Type
tpl Template[]
scope? undefined | object
renderOptions? RenderOptions

Returns: any

renderToNodeStream

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

Defined in src/liquid.ts:52

Parameters:

Name Type Default
tpl Template[] -
scope? undefined | object -
renderOptions RenderOptions {}

Returns: ReadableStream

Next