Interface: LiquidOptions

Hierarchy

Properties

Optional cache

cache? : boolean | number | CacheTemplate[]›

Defined in liquid-options.ts:13

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


Optional dynamicPartials

dynamicPartials? : undefined | false | true

Defined in liquid-options.ts:17

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

Defined in liquid-options.ts:11

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? : FS

Defined in liquid-options.ts:41

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


Optional globals

globals? : undefined | object

Defined in liquid-options.ts:43

the global environment passed down to all partial templates, i.e. templates included by include, layout and render tags.


Optional greedy

greedy? : undefined | false | true

Defined in liquid-options.ts:39

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 jsTruthy

jsTruthy? : undefined | false | true

Defined in liquid-options.ts:15

Use Javascript Truthiness. Defaults to false.


Optional outputDelimiterLeft

outputDelimiterLeft? : undefined | string

Defined in liquid-options.ts:35

The left delimiter for liquid outputs.


Optional outputDelimiterRight

outputDelimiterRight? : undefined | string

Defined in liquid-options.ts:37

The right delimiter for liquid outputs.


Optional root

root? : string | string[]

Defined in liquid-options.ts:9

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

Defined in liquid-options.ts:19

Whether or not to assert filter existence. If set to false, undefined filters will be skipped. Otherwise, undefined filters will cause an exception. Defaults to false.


Optional strictVariables

strictVariables? : undefined | false | true

Defined in liquid-options.ts:21

Whether or not to assert variable existence. 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

Defined in liquid-options.ts:31

The left delimiter for liquid tags.


Optional tagDelimiterRight

tagDelimiterRight? : undefined | string

Defined in liquid-options.ts:33

The right delimiter for liquid tags.


Optional trimOutputLeft

trimOutputLeft? : undefined | false | true

Defined in liquid-options.ts:29

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


Optional trimOutputRight

trimOutputRight? : undefined | false | true

Defined in liquid-options.ts:27

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


Optional trimTagLeft

trimTagLeft? : undefined | false | true

Defined in liquid-options.ts:25

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


Optional trimTagRight

trimTagRight? : undefined | false | true

Defined in liquid-options.ts:23

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