Class Liquid

Hierarchy

Liquid

Index

Constructors

constructor

Properties

Constructors

constructor

new Liquid(opts?: LiquidOptions): Liquid

- Defined in liquid.ts:29
Parameters
- Default value opts: LiquidOptions = {}
Returns Liquid

Properties

Private cache

cache: object

filters

filters: FilterMap

Private fs

fs: IFS

options

options: NormalizedFullOptions

parser

parser: Parser

renderer

renderer: Render

tags

tags: TagMap

Private tokenizer

tokenizer: Tokenizer

Methods

_evalValue

_evalValue(str: string, ctx: Context): IterableIterator<any>

- Defined in liquid.ts:103
Parameters
- str: string
- ctx: Context
Returns IterableIterator<any>

_parseAndRender

_parseAndRender(html: string, scope?: undefined | object, opts?: LiquidOptions, sync?: undefined | false | true): IterableIterator<string>

- Defined in liquid.ts:60
Parameters
- html: string
- Optional scope: undefined | object
- Optional opts: LiquidOptions
- Optional sync: undefined | false | true
Returns IterableIterator<string>

_parseFile

_parseFile(file: string, opts?: LiquidOptions, sync?: undefined | false | true): IterableIterator<any>

- Defined in liquid.ts:71
Parameters
- file: string
- Optional opts: LiquidOptions
- Optional sync: undefined | false | true
Returns IterableIterator<any>

_render

_render(tpl: Template[], scope?: undefined | object, opts?: LiquidOptions, sync?: undefined | false | true): IterableIterator<string>

- Defined in liquid.ts:48
Parameters
- tpl: Template[]
- Optional scope: undefined | object
- Optional opts: LiquidOptions
- Optional sync: undefined | false | true
Returns IterableIterator<string>

evalValue

evalValue(str: string, ctx: Context): Promise<any>

- Defined in liquid.ts:107
Parameters
- str: string
- ctx: Context
Returns Promise<any>

evalValueSync

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

- Defined in liquid.ts:110
Parameters
- str: string
- ctx: Context
Returns any

express

express(): (Anonymous function)

- Defined in liquid.ts:123
Returns (Anonymous function)

getTemplate

getTemplate(file: string, opts?: LiquidOptions): Promise<Template[]>

- Defined in liquid.ts:141
deprecated

use parseFile instead

Parameters
- file: string
- Optional opts: LiquidOptions
Returns Promise<Template[]>

getTemplateSync

getTemplateSync(file: string, opts?: LiquidOptions): Template[]

- Defined in liquid.ts:147
deprecated

use parseFileSync instead

Parameters
- file: string
- Optional opts: LiquidOptions
Returns Template[]

Private lookupError

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

- Defined in liquid.ts:131
Parameters
- file: string
- roots: string[]
Returns any

parse

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

- Defined in liquid.ts:43
Parameters
- html: string
- Optional filepath: undefined | string
Returns Template[]

parseAndRender

parseAndRender(html: string, scope?: undefined | object, opts?: LiquidOptions): Promise<string>

- Defined in liquid.ts:64
Parameters
- html: string
- Optional scope: undefined | object
- Optional opts: LiquidOptions
Returns Promise<string>

parseAndRenderSync

parseAndRenderSync(html: string, scope?: undefined | object, opts?: LiquidOptions): string

- Defined in liquid.ts:67
Parameters
- html: string
- Optional scope: undefined | object
- Optional opts: LiquidOptions
Returns string

parseFile

parseFile(file: string, opts?: LiquidOptions): Promise<Template[]>

- Defined in liquid.ts:87
Parameters
- file: string
- Optional opts: LiquidOptions
Returns Promise<Template[]>

parseFileSync

parseFileSync(file: string, opts?: LiquidOptions): Template[]

- Defined in liquid.ts:90
Parameters
- file: string
- Optional opts: LiquidOptions
Returns Template[]

plugin

plugin(plugin: function): void

- Defined in liquid.ts:120
Parameters
- plugin: function
  - - (this: Liquid, L: Liquid): void
    - Parameters
      - this: Liquid
      - L: Liquid
      Returns void
Returns void

registerFilter

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

- Defined in liquid.ts:114
Parameters
- name: string
- filter: FilterImplOptions
Returns void

registerTag

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

- Defined in liquid.ts:117
Parameters
- name: string
- tag: TagImplOptions
Returns void

render

render(tpl: Template[], scope?: undefined | object, opts?: LiquidOptions): Promise<string>

- Defined in liquid.ts:53
Parameters
- tpl: Template[]
- Optional scope: undefined | object
- Optional opts: LiquidOptions
Returns Promise<string>

renderFile

renderFile(file: string, ctx?: undefined | object, opts?: LiquidOptions): Promise<string>

- Defined in liquid.ts:93
Parameters
- file: string
- Optional ctx: undefined | object
- Optional opts: LiquidOptions
Returns Promise<string>

renderFileSync

renderFileSync(file: string, ctx?: undefined | object, opts?: LiquidOptions): string

- Defined in liquid.ts:97
Parameters
- file: string
- Optional ctx: undefined | object
- Optional opts: LiquidOptions
Returns string

renderSync

renderSync(tpl: Template[], scope?: undefined | object, opts?: LiquidOptions): string

- Defined in liquid.ts:56
Parameters
- tpl: Template[]
- Optional scope: undefined | object
- Optional opts: LiquidOptions
Returns string

Generated using TypeDoc