Hierarchy
-
↳ NormalizedOptions
Properties
Optional cache
• cache? : Cache‹Thenable‹Template[]››
Overrides LiquidOptions.cache
Defined in src/liquid-options.ts:107
Optional dynamicPartials
• dynamicPartials? : undefined | false | true
Inherited from LiquidOptions.dynamicPartials
Defined in src/liquid-options.ts:39
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
Inherited from LiquidOptions.extname
Defined in src/liquid-options.ts:33
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
Inherited from LiquidOptions.fs
Defined in src/liquid-options.ts:71
fs is used to override the default file-system module with a custom implementation.
Optional globals
• globals? : undefined | object
Inherited from LiquidOptions.globals
Defined in src/liquid-options.ts:73
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
Inherited from LiquidOptions.greedy
Defined in src/liquid-options.ts:69
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
Inherited from LiquidOptions.jekyllInclude
Defined in src/liquid-options.ts:31
Use jekyll style include, pass parameters to include variable of current scope. Defaults to false.
Optional jsTruthy
• jsTruthy? : undefined | false | true
Inherited from LiquidOptions.jsTruthy
Defined in src/liquid-options.ts:37
Use Javascript Truthiness. Defaults to false.
Optional keepOutputType
• keepOutputType? : undefined | false | true
Inherited from LiquidOptions.keepOutputType
Defined in src/liquid-options.ts:75
Whether or not to keep value type when writing the Output, not working for streamed rendering. Defaults to false.
Optional layouts
• layouts? : string[]
Overrides LiquidOptions.layouts
Defined in src/liquid-options.ts:106
Optional lenientIf
• lenientIf? : undefined | false | true
Inherited from LiquidOptions.lenientIf
Defined in src/liquid-options.ts:47
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
Inherited from LiquidOptions.operators
Defined in src/liquid-options.ts:79
An object of operators for conditional statements. Defaults to the regular Liquid operators.
Optional operatorsTrie
• operatorsTrie? : Trie
Defined in src/liquid-options.ts:109
Optional orderedFilterParameters
• orderedFilterParameters? : undefined | false | true
Inherited from LiquidOptions.orderedFilterParameters
Defined in src/liquid-options.ts:81
Respect parameter order when using filters like “for … reversed limit”, Defaults to false.
Optional outputDelimiterLeft
• outputDelimiterLeft? : undefined | string
Inherited from LiquidOptions.outputDelimiterLeft
Defined in src/liquid-options.ts:63
The left delimiter for liquid outputs.
Optional outputDelimiterRight
• outputDelimiterRight? : undefined | string
Inherited from LiquidOptions.outputDelimiterRight
Defined in src/liquid-options.ts:65
The right delimiter for liquid outputs.
Optional outputEscape
• outputEscape? : OutputEscape
Overrides LiquidOptions.outputEscape
Defined in src/liquid-options.ts:108
Optional ownPropertyOnly
• ownPropertyOnly? : undefined | false | true
Inherited from LiquidOptions.ownPropertyOnly
Defined in src/liquid-options.ts:45
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[]
Overrides LiquidOptions.partials
Defined in src/liquid-options.ts:105
Optional preserveTimezones
• preserveTimezones? : undefined | false | true
Inherited from LiquidOptions.preserveTimezones
Defined in src/liquid-options.ts:67
Whether input strings to date filter preserve the given timezone
Optional relativeReference
• relativeReference? : undefined | false | true
Inherited from LiquidOptions.relativeReference
Defined in src/liquid-options.ts:29
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[]
Overrides LiquidOptions.root
Defined in src/liquid-options.ts:104
Optional strictFilters
• strictFilters? : undefined | false | true
Inherited from LiquidOptions.strictFilters
Defined in src/liquid-options.ts:41
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
Inherited from LiquidOptions.strictVariables
Defined in src/liquid-options.ts:43
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
Inherited from LiquidOptions.tagDelimiterLeft
Defined in src/liquid-options.ts:59
The left delimiter for liquid tags.
Optional tagDelimiterRight
• tagDelimiterRight? : undefined | string
Inherited from LiquidOptions.tagDelimiterRight
Defined in src/liquid-options.ts:61
The right delimiter for liquid tags.
Optional timezoneOffset
• timezoneOffset? : undefined | number
Inherited from LiquidOptions.timezoneOffset
Defined in src/liquid-options.ts:49
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
Inherited from LiquidOptions.trimOutputLeft
Defined in src/liquid-options.ts:57
Similar to trimOutputRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.
Optional trimOutputRight
• trimOutputRight? : undefined | false | true
Inherited from LiquidOptions.trimOutputRight
Defined in src/liquid-options.ts:55
Strip blank characters (including , \t, and \r) from the right of values ({{ }}) until \n (inclusive). Defaults to false.
Optional trimTagLeft
• trimTagLeft? : undefined | false | true
Inherited from LiquidOptions.trimTagLeft
Defined in src/liquid-options.ts:53
Similar to trimTagRight, whereas the \n is exclusive. Defaults to false. See Whitespace Control for details.
Optional trimTagRight
• trimTagRight? : undefined | false | true
Inherited from LiquidOptions.trimTagRight
Defined in src/liquid-options.ts:51
Strip blank characters (including , \t, and \r) from the right of tags ({% %}) until \n (inclusive). Defaults to false.