Class Liquid

Hierarchy

Liquid

Constructors

constructor

new Liquid(opts?: LiquidOptions): Liquid
Parameters
- opts: LiquidOptions = {}
Returns Liquid
- Defined in src/liquid.ts:21

Properties

`Readonly` filters

filters: Record<string, FilterImplOptions> = {}

`Readonly` options

options: NormalizedFullOptions

`Readonly` parser

parser: Parser

Deprecated

will be removed. In tags use this.parser instead

`Readonly` renderer

renderer: Render = ...

`Readonly` tags

tags: Record<string, TagClass> = {}

Methods

_evalValue

_evalValue(str: string, scope?: object | Context): IterableIterator<any>
Parameters
- str: string
- Optional scope: object | Context
Returns IterableIterator<any>
- Defined in src/liquid.ts:89

_parseAndRender

_parseAndRender(html: string, scope: undefined | object | Context, renderOptions: RenderOptions): IterableIterator<any>
Parameters
- html: string
- scope: undefined | object | Context
- renderOptions: RenderOptions
Returns IterableIterator<any>
- Defined in src/liquid.ts:48

_parseFile

_parseFile(file: string, sync?: boolean, lookupType?: LookupType, currentFile?: string): Generator<unknown, Template[], unknown>
Parameters
- file: string
- Optional sync: boolean
- Optional lookupType: LookupType
- Optional currentFile: string
Returns Generator<unknown, Template[], unknown>
- Defined in src/liquid.ts:65

_parseLayoutFile

_parseLayoutFile(file: string, sync?: boolean, currentFile?: string): Generator<unknown, Template[], string | Template[]>
Parameters
- file: string
- Optional sync: boolean
- Optional currentFile: string
Returns Generator<unknown, Template[], string | Template[]>
- Defined in src/liquid.ts:62

_parsePartialFile

_parsePartialFile(file: string, sync?: boolean, currentFile?: string): Generator<unknown, Template[], string | Template[]>
Parameters
- file: string
- Optional sync: boolean
- Optional currentFile: string
Returns Generator<unknown, Template[], string | Template[]>
- Defined in src/liquid.ts:59

_render

_render(tpl: Template[], scope: undefined | object | Context, renderOptions: RenderOptions): IterableIterator<any>
Parameters
- tpl: Template[]
- scope: undefined | object | Context
- renderOptions: RenderOptions
Returns IterableIterator<any>
- Defined in src/liquid.ts:33

_renderFile

_renderFile(file: string, ctx: undefined | object | Context, renderFileOptions: RenderFileOptions): Generator<any, any, unknown>
Parameters
- file: string
- ctx: undefined | object | Context
- renderFileOptions: RenderFileOptions
Returns Generator<any, any, unknown>
- Defined in src/liquid.ts:74

evalValue

evalValue(str: string, scope?: object | Context): Promise<any>
Parameters
- str: string
- Optional scope: object | Context
Returns Promise<any>
- Defined in src/liquid.ts:94

evalValueSync

evalValueSync(str: string, scope?: object | Context): any
Parameters
- str: string
- Optional scope: object | Context
Returns any
- Defined in src/liquid.ts:97

express

express(): ((this: any, filePath: string, ctx: object, callback: ((err: null | Error, rendered: string) => void)) => void)
Returns ((this: any, filePath: string, ctx: object, callback: ((err: null | Error, rendered: string) => void)) => void)
- - (this: any, filePath: string, ctx: object, callback: ((err: null | Error, rendered: string) => void)): void
  - Parameters
    - this: any
    - filePath: string
    - ctx: object
    - callback: ((err: null | Error, rendered: string) => void)
      
      (err: null | Error, rendered: string): void
      
      Parameters
      
      err: null | Error
      
      rendered: string
      
      Returns void
    Returns void
- Defined in src/liquid.ts:110

parse

parse(html: string, filepath?: string): Template[]
Parameters
- html: string
- Optional filepath: string
Returns Template[]
- Defined in src/liquid.ts:28

parseAndRender

parseAndRender(html: string, scope?: object | Context, renderOptions?: RenderOptions): Promise<any>
Parameters
- html: string
- Optional scope: object | Context
- Optional renderOptions: RenderOptions
Returns Promise<any>
- Defined in src/liquid.ts:52

parseAndRenderSync

parseAndRenderSync(html: string, scope?: object | Context, renderOptions?: RenderOptions): any
Parameters
- html: string
- Optional scope: object | Context
- Optional renderOptions: RenderOptions
Returns any
- Defined in src/liquid.ts:55

parseFile

parseFile(file: string, lookupType?: LookupType): Promise<Template[]>
Parameters
- file: string
- Optional lookupType: LookupType
Returns Promise<Template[]>
- Defined in src/liquid.ts:68

parseFileSync

parseFileSync(file: string, lookupType?: LookupType): Template[]
Parameters
- file: string
- Optional lookupType: LookupType
Returns Template[]
- Defined in src/liquid.ts:71

plugin

plugin(plugin: ((this: Liquid, L: typeof Liquid) => void)): void
Parameters
- plugin: ((this: Liquid, L: typeof Liquid) => void)
  - - (this: Liquid, L: typeof Liquid): void
    - Parameters
      
      this: Liquid
      
      L: typeof Liquid
      
      Returns void
Returns void
- Defined in src/liquid.ts:107

registerFilter

registerFilter(name: string, filter: FilterImplOptions): void
Parameters
- name: string
- filter: FilterImplOptions
Returns void
- Defined in src/liquid.ts:101

registerTag

registerTag(name: string, tag: TagClass | TagImplOptions): void
Parameters
- name: string
- tag: TagClass | TagImplOptions
Returns void
- Defined in src/liquid.ts:104

render

render(tpl: Template[], scope?: object, renderOptions?: RenderOptions): Promise<any>
Parameters
- tpl: Template[]
- Optional scope: object
- Optional renderOptions: RenderOptions
Returns Promise<any>
- Defined in src/liquid.ts:37

renderFile

renderFile(file: string, ctx?: object | Context, renderFileOptions?: RenderFileOptions): Promise<any>
Parameters
- file: string
- Optional ctx: object | Context
- Optional renderFileOptions: RenderFileOptions
Returns Promise<any>
- Defined in src/liquid.ts:78

renderFileSync

renderFileSync(file: string, ctx?: object | Context, renderFileOptions?: RenderFileOptions): any
Parameters
- file: string
- Optional ctx: object | Context
- Optional renderFileOptions: RenderFileOptions
Returns any
- Defined in src/liquid.ts:81

renderFileToNodeStream

renderFileToNodeStream(file: string, scope?: object, renderOptions?: RenderOptions): Promise<ReadableStream>
Parameters
- file: string
- Optional scope: object
- Optional renderOptions: RenderOptions
Returns Promise<ReadableStream>
- Defined in src/liquid.ts:84

renderSync

renderSync(tpl: Template[], scope?: object, renderOptions?: RenderOptions): any
Parameters
- tpl: Template[]
- Optional scope: object
- Optional renderOptions: RenderOptions
Returns any
- Defined in src/liquid.ts:40

renderToNodeStream

renderToNodeStream(tpl: Template[], scope?: object, renderOptions?: RenderOptions): ReadableStream
Parameters
- tpl: Template[]
- Optional scope: object
- renderOptions: RenderOptions = {}
Returns ReadableStream
- Defined in src/liquid.ts:43

Class Liquid

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

opts: LiquidOptions = {}

Returns Liquid

Properties

Readonly filters

Readonly options

Readonly parser

Deprecated

Readonly renderer

Readonly tags

Methods

_evalValue

Parameters

str: string

Optional scope: object | Context

Returns IterableIterator<any>

_parseAndRender

Parameters

html: string

scope: undefined | object | Context

renderOptions: RenderOptions

Returns IterableIterator<any>

_parseFile

Parameters

file: string

Optional sync: boolean

Optional lookupType: LookupType

Optional currentFile: string

Returns Generator<unknown, Template[], unknown>

_parseLayoutFile

Parameters

file: string

Optional sync: boolean

Optional currentFile: string

Returns Generator<unknown, Template[], string | Template[]>

_parsePartialFile

Parameters

file: string

Optional sync: boolean

Optional currentFile: string

Returns Generator<unknown, Template[], string | Template[]>

_render

Parameters

tpl: Template[]

scope: undefined | object | Context

renderOptions: RenderOptions

Returns IterableIterator<any>

_renderFile

Parameters

file: string

ctx: undefined | object | Context

renderFileOptions: RenderFileOptions

Returns Generator<any, any, unknown>

evalValue

Parameters

str: string

Optional scope: object | Context

Returns Promise<any>

evalValueSync

Parameters

str: string

Optional scope: object | Context

Returns any

express

Returns ((this: any, filePath: string, ctx: object, callback: ((err: null | Error, rendered: string) => void)) => void)

Parameters

this: any

filePath: string

ctx: object

callback: ((err: null | Error, rendered: string) => void)

Parameters

err: null | Error

`Readonly` filters

`Readonly` options

`Readonly` parser

`Readonly` renderer

`Readonly` tags

`Optional` scope: object | Context

`Optional` sync: boolean

`Optional` lookupType: LookupType

`Optional` currentFile: string

`Optional` sync: boolean

`Optional` currentFile: string

`Optional` sync: boolean

`Optional` currentFile: string

`Optional` scope: object | Context

`Optional` scope: object | Context

`Optional` filepath: string

`Optional` scope: object | Context

`Optional` renderOptions: RenderOptions

`Optional` scope: object | Context

`Optional` renderOptions: RenderOptions

`Optional` lookupType: LookupType

`Optional` lookupType: LookupType

`Optional` scope: object

`Optional` renderOptions: RenderOptions

`Optional` ctx: object | Context

`Optional` renderFileOptions: RenderFileOptions

`Optional` ctx: object | Context

`Optional` renderFileOptions: RenderFileOptions

`Optional` scope: object