Class: Liquid

Hierarchy

  • Liquid

Constructors

constructor

+ new Liquid(opts: LiquidOptions): Liquid

Defined in src/liquid.ts:16

Parameters:

Name Type Default
opts LiquidOptions {}

Returns: Liquid

Properties

Readonly filters

• filters: Record‹string, FilterImplOptions›

Defined in src/liquid.ts:15

Readonly options

• options: NormalizedFullOptions

Defined in src/liquid.ts:12

Readonly parser

• parser: Parser

Defined in src/liquid.ts:14

Readonly renderer

• renderer: Render‹› = new Render()

Defined in src/liquid.ts:13

Readonly tags

• tags: Record‹string, TagClass›

Defined in src/liquid.ts:16

Methods

_evalValue

▸ _evalValue(str: string, scope?: object | Context): IterableIterator‹any›

Defined in src/liquid.ts:84

Parameters:

Name Type
str string
scope? object | Context

Returns: IterableIterator‹any›

_parseAndRender

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

Defined in src/liquid.ts:43

Parameters:

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

Returns: IterableIterator‹any›

_parseFile

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

Defined in src/liquid.ts:60

Parameters:

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

Returns: Generator‹unknown, Template[]›

_parseLayoutFile

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

Defined in src/liquid.ts:57

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

Parameters:

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

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

_render

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

Defined in src/liquid.ts:28

Parameters:

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

Returns: IterableIterator‹any›

_renderFile

▸ _renderFile(file: string, ctx: Context | object | undefined, renderFileOptions: RenderFileOptions): Generator‹any›

Defined in src/liquid.ts:69

Parameters:

Name Type
file string
ctx Context | object | undefined
renderFileOptions RenderFileOptions

Returns: Generator‹any›

evalValue

▸ evalValue(str: string, scope?: object | Context): Promise‹any›

Defined in src/liquid.ts:89

Parameters:

Name Type
str string
scope? object | Context

Returns: Promise‹any›

evalValueSync

▸ evalValueSync(str: string, scope?: object | Context): any

Defined in src/liquid.ts:92

Parameters:

Name Type
str string
scope? object | Context

Returns: any

express

▸ express(): (Anonymous function)

Defined in src/liquid.ts:105

Returns: (Anonymous function)

parse

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

Defined in src/liquid.ts:24

Parameters:

Name Type
html string
filepath? undefined | string

Returns: Template[]

parseAndRender

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

Defined in src/liquid.ts:47

Parameters:

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

Returns: Promise‹any›

parseAndRenderSync

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

Defined in src/liquid.ts:50

Parameters:

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

Returns: any

parseFile

▸ parseFile(file: string, lookupType?: LookupType): Promise‹Template[]›

Defined in src/liquid.ts:63

Parameters:

Name Type
file string
lookupType? LookupType

Returns: Promise‹Template[]›

parseFileSync

▸ parseFileSync(file: string, lookupType?: LookupType): Template[]

Defined in src/liquid.ts:66

Parameters:

Name Type
file string
lookupType? LookupType

Returns: Template[]

plugin

▸ plugin(plugin: function): void

Defined in src/liquid.ts:102

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

Parameters:

Name Type
name string
filter FilterImplOptions

Returns: void

registerTag

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

Defined in src/liquid.ts:99

Parameters:

Name Type
name string
tag TagClass | TagImplOptions

Returns: void

render

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

Defined in src/liquid.ts:32

Parameters:

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

Returns: Promise‹any›

renderFile

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

Defined in src/liquid.ts:73

Parameters:

Name Type
file string
ctx? Context | object
renderFileOptions? RenderFileOptions

Returns: Promise‹any›

renderFileSync

▸ renderFileSync(file: string, ctx?: Context | object, renderFileOptions?: RenderFileOptions): any

Defined in src/liquid.ts:76

Parameters:

Name Type
file string
ctx? Context | object
renderFileOptions? RenderFileOptions

Returns: any

renderFileToNodeStream

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

Defined in src/liquid.ts:79

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

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

Parameters:

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

Returns: ReadableStream

Next