Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LiquidOptions

Hierarchy

Index

Properties

Optional cache

cache: undefined | false | true

Whether or not to cache resolved templates. Defaults to false.

Optional dynamicPartials

dynamicPartials: undefined | false | true

If set, treat the filepath parameter in {%include filepath %} and {%layout filepath%} as a variable, otherwise as a literal value. Defaults to true.

Optional extname

extname: undefined | string

Add a extname (if filepath doesn't include one) before template file lookup. Eg: setting to ".html" will allow including file by basename. Defaults to "".

Optional fs

fs: IFS

fs is used to override the default file-system module with a custom implementation.

Optional greedy

greedy: undefined | false | true

Whether trim*Left/trim*Right is greedy. When set to true, all consecutive blank characters including \n will be trimed regardless of line breaks. Defaults to true.

Optional outputDelimiterLeft

outputDelimiterLeft: undefined | string

The left delimiter for liquid outputs.

Optional outputDelimiterRight

outputDelimiterRight: undefined | string

The right delimiter for liquid outputs.

Optional root

root: string | string[]

A directory or an array of directories from where to resolve layout and include templates, and the filename passed to .renderFile(). If it's an array, the files are looked up in the order they occur in the array. Defaults to ["."]

Optional strictFilters

strictFilters: undefined | false | true

Enable strict filter existence. If set to false, undefined filters will be rendered as empty string. Otherwise, undefined filters will cause an exception. Defaults to false.

Optional strictVariables

strictVariables: undefined | false | true

Enable strict variable derivation. If set to false, undefined variables will be rendered as empty string. Otherwise, undefined variables will cause an exception. Defaults to false.

Optional tagDelimiterLeft

tagDelimiterLeft: undefined | string

The left delimiter for liquid tags.

Optional tagDelimiterRight

tagDelimiterRight: undefined | string

The right delimiter for liquid tags.

Optional trimOutputLeft

trimOutputLeft: undefined | false | true

Similar to trimOutputRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.

Optional trimOutputRight

trimOutputRight: undefined | false | true

Strip blank characters (including , \t, and \r) from the right of values ({{ }}) until \n (inclusive). Defaults to false.

Optional trimTagLeft

trimTagLeft: undefined | false | true

Similar to trimTagRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.

Optional trimTagRight

trimTagRight: undefined | false | true

Strip blank characters (including , \t, and \r) from the right of tags ({% %}) until \n (inclusive). Defaults to false.

Generated using TypeDoc