Interface: LiquidOptions

Hierarchy

Properties

Optional cache

cache? : boolean | number | LiquidCache

Defined in src/liquid-options.ts:33

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


Optional dynamicPartials

dynamicPartials? : undefined | false | true

Defined in src/liquid-options.ts:37

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 src/liquid-options.ts:31

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 src/liquid-options.ts:69

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


Optional globals

globals? : undefined | object

Defined in src/liquid-options.ts:71

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


Optional greedy

greedy? : undefined | false | true

Defined in src/liquid-options.ts:67

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 jekyllInclude

jekyllInclude? : undefined | false | true

Defined in src/liquid-options.ts:29

Use jekyll style include, pass parameters to include variable of current scope. Defaults to false.


Optional jsTruthy

jsTruthy? : undefined | false | true

Defined in src/liquid-options.ts:35

Use Javascript Truthiness. Defaults to false.


Optional keepOutputType

keepOutputType? : undefined | false | true

Defined in src/liquid-options.ts:73

Whether or not to keep value type when writing the Output, not working for streamed rendering. Defaults to false.


Optional layouts

layouts? : string | string[]

Defined in src/liquid-options.ts:25

A directory or an array of directories from where to resolve layout templates. If it’s an array, the files are looked up in the order they occur in the array. Defaults to root


Optional lenientIf

lenientIf? : undefined | false | true

Defined in src/liquid-options.ts:45

Modifies the behavior of strictVariables. If set, a single undefined variable will not cause an exception in the context of the if/elsif/unless tag and the default filter. Instead, it will evaluate to false and null, respectively. Irrelevant if strictVariables is not set. Defaults to false.


Optional operators

operators? : Operators

Defined in src/liquid-options.ts:77

An object of operators for conditional statements. Defaults to the regular Liquid operators.


Optional orderedFilterParameters

orderedFilterParameters? : undefined | false | true

Defined in src/liquid-options.ts:79

Respect parameter order when using filters like “for … reversed limit”, Defaults to false.


Optional outputDelimiterLeft

outputDelimiterLeft? : undefined | string

Defined in src/liquid-options.ts:61

The left delimiter for liquid outputs.


Optional outputDelimiterRight

outputDelimiterRight? : undefined | string

Defined in src/liquid-options.ts:63

The right delimiter for liquid outputs.


Optional outputEscape

outputEscape? : OutputEscapeOption

Defined in src/liquid-options.ts:75

Default escape filter applied to output values, when set, you’ll have to add | raw for values don’t need to be escaped. Defaults to undefined.


Optional ownPropertyOnly

ownPropertyOnly? : undefined | false | true

Defined in src/liquid-options.ts:43

Hide scope variables from prototypes, useful when you’re passing a not sanitized object into LiquidJS or need to hide prototypes from templates.


Optional partials

partials? : string | string[]

Defined in src/liquid-options.ts:23

A directory or an array of directories from where to resolve included templates. If it’s an array, the files are looked up in the order they occur in the array. Defaults to root


Optional preserveTimezones

preserveTimezones? : undefined | false | true

Defined in src/liquid-options.ts:65

Whether input strings to date filter preserve the given timezone


Optional relativeReference

relativeReference? : undefined | false | true

Defined in src/liquid-options.ts:27

Allow refer to layouts/partials by relative pathname. To avoid arbitrary filesystem read, paths been referenced also need to be within corresponding root, partials, layouts. Defaults to true.


Optional root

root? : string | string[]

Defined in src/liquid-options.ts:21

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 src/liquid-options.ts:39

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 src/liquid-options.ts:41

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 src/liquid-options.ts:57

The left delimiter for liquid tags.


Optional tagDelimiterRight

tagDelimiterRight? : undefined | string

Defined in src/liquid-options.ts:59

The right delimiter for liquid tags.


Optional timezoneOffset

timezoneOffset? : undefined | number

Defined in src/liquid-options.ts:47

JavaScript timezoneOffset for date filter, default to local time. That means if you’re in Australia (UTC+10), it’ll default to -600


Optional trimOutputLeft

trimOutputLeft? : undefined | false | true

Defined in src/liquid-options.ts:55

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


Optional trimOutputRight

trimOutputRight? : undefined | false | true

Defined in src/liquid-options.ts:53

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 src/liquid-options.ts:51

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


Optional trimTagRight

trimTagRight? : undefined | false | true

Defined in src/liquid-options.ts:49

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