From ef1af66cd2bf3e85de5dcfcd48cd90b0f2baa663 Mon Sep 17 00:00:00 2001 From: harttle Date: Mon, 6 Jul 2026 12:13:00 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20harttle/?= =?UTF-8?q?liquidjs@552819a84b80c62306fe61072628a756272dc749=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/functions/toValue.html | 2 +- api/index.html | 3 + api/interfaces/LiquidOptions.html | 53 +- api/interfaces/RenderFileOptions.html | 16 +- api/interfaces/RenderOptions.html | 16 +- .../_internal_.NormalizedFullOptions.html | 77 +- .../_internal_.NormalizedOptions.html | 63 +- api/variables/defaultOptions.html | 2 +- filters/abs.html | 2 +- filters/append.html | 2 +- filters/array_to_sentence_string.html | 2 +- filters/at_least.html | 2 +- filters/at_most.html | 2 +- filters/base64_decode.html | 2 +- filters/base64_encode.html | 2 +- filters/capitalize.html | 2 +- filters/ceil.html | 2 +- filters/cgi_escape.html | 2 +- filters/compact.html | 2 +- filters/concat.html | 2 +- filters/date.html | 2 +- filters/date_to_long_string.html | 2 +- filters/date_to_rfc822.html | 2 +- filters/date_to_string.html | 2 +- filters/date_to_xmlschema.html | 2 +- filters/default.html | 2 +- filters/divided_by.html | 2 +- filters/downcase.html | 2 +- filters/escape.html | 2 +- filters/escape_once.html | 2 +- filters/find.html | 2 +- filters/find_exp.html | 2 +- filters/find_index.html | 2 +- filters/find_index_exp.html | 2 +- filters/first.html | 2 +- filters/floor.html | 2 +- filters/group_by.html | 2 +- filters/group_by_exp.html | 2 +- filters/has.html | 2 +- filters/has_exp.html | 2 +- filters/hmac_sha256.html | 2 +- filters/inspect.html | 2 +- filters/join.html | 2 +- filters/json.html | 2 +- filters/jsonify.html | 2 +- filters/last.html | 2 +- filters/lstrip.html | 2 +- filters/map.html | 2 +- filters/minus.html | 2 +- filters/modulo.html | 2 +- filters/newline_to_br.html | 2 +- filters/normalize_whitespace.html | 2 +- filters/number_of_words.html | 2 +- filters/overview.html | 2 +- filters/plus.html | 2 +- filters/pop.html | 2 +- filters/prepend.html | 2 +- filters/push.html | 2 +- filters/raw.html | 2 +- filters/reject.html | 2 +- filters/reject_exp.html | 2 +- filters/remove.html | 2 +- filters/remove_first.html | 2 +- filters/remove_last.html | 2 +- filters/replace.html | 2 +- filters/replace_first.html | 2 +- filters/replace_last.html | 2 +- filters/reverse.html | 2 +- filters/round.html | 2 +- filters/rstrip.html | 2 +- filters/sha256.html | 2 +- filters/shift.html | 2 +- filters/size.html | 2 +- filters/slice.html | 2 +- filters/slugify.html | 2 +- filters/sort.html | 2 +- filters/sort_natural.html | 2 +- filters/split.html | 2 +- filters/strip.html | 2 +- filters/strip_html.html | 2 +- filters/strip_newlines.html | 2 +- filters/sum.html | 2 +- filters/times.html | 2 +- filters/to_integer.html | 2 +- filters/truncate.html | 2 +- filters/truncatewords.html | 2 +- filters/uniq.html | 2 +- filters/unshift.html | 2 +- filters/upcase.html | 2 +- filters/uri_escape.html | 2 +- filters/url_decode.html | 2 +- filters/url_encode.html | 2 +- filters/where.html | 2 +- filters/where_exp.html | 2 +- filters/xml_escape.html | 2 +- index.html | 2 +- js/liquid.browser.min.js | 2 +- sitemap.xml | 808 +++++++++--------- tags/assign.html | 2 +- tags/capture.html | 2 +- tags/case.html | 2 +- tags/comment.html | 2 +- tags/cycle.html | 2 +- tags/decrement.html | 2 +- tags/echo.html | 2 +- tags/for.html | 2 +- tags/if.html | 2 +- tags/include.html | 2 +- tags/increment.html | 2 +- tags/inline_comment.html | 2 +- tags/layout.html | 2 +- tags/liquid.html | 2 +- tags/overview.html | 2 +- tags/raw.html | 2 +- tags/render.html | 2 +- tags/tablerow.html | 2 +- tags/unless.html | 2 +- tutorials/access-scope-in-filters.html | 2 +- tutorials/caching.html | 2 +- tutorials/changelog.html | 2 +- tutorials/contribution-guidelines.html | 2 +- tutorials/differences.html | 2 +- tutorials/drops.html | 2 +- tutorials/escaping.html | 2 +- tutorials/intro-to-liquid.html | 2 +- tutorials/migrate-to-9.html | 2 +- tutorials/operators.html | 2 +- tutorials/options.html | 2 +- tutorials/parse-parameters.html | 2 +- tutorials/partials-and-layouts.html | 2 +- tutorials/plugins.html | 2 +- tutorials/register-filters-tags.html | 2 +- tutorials/render-file.html | 2 +- tutorials/render-tag-content.html | 2 +- tutorials/security-model.html | 2 +- tutorials/setup.html | 2 +- tutorials/static-analysis.html | 2 +- tutorials/sync-and-async.html | 2 +- tutorials/truthy-and-falsy.html | 2 +- tutorials/use-in-expressjs.html | 2 +- tutorials/whitespace-control.html | 2 +- 141 files changed, 655 insertions(+), 649 deletions(-) diff --git a/api/functions/toValue.html b/api/functions/toValue.html index 99e601320..1adaae19d 100644 --- a/api/functions/toValue.html +++ b/api/functions/toValue.html @@ -1 +1 @@ -toValue | liquidjs

Function toValue

Settings

Member Visibility
+toValue | liquidjs

Function toValue

Settings

Member Visibility
diff --git a/api/index.html b/api/index.html index 79b6a635a..5c2aba969 100644 --- a/api/index.html +++ b/api/index.html @@ -203,6 +203,9 @@ Tal
Tal
💻 Vladimir Filonov
Vladimir Filonov
💻 + + spokodev
spokodev
💻 + diff --git a/api/interfaces/LiquidOptions.html b/api/interfaces/LiquidOptions.html index 9e46fe8c8..bd0b84a83 100644 --- a/api/interfaces/LiquidOptions.html +++ b/api/interfaces/LiquidOptions.html @@ -40,40 +40,41 @@

Properties

Optionalcache

cache?: number | boolean | LiquidCache

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

OptionalcatchAllErrors

catchAllErrors?: boolean

Catch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.

OptionaldateFormat

dateFormat?: string

Default date format to use if the date filter doesn't include a format. Defaults to %A, %B %-e, %Y at %-l:%M %P %z.

-

OptionaldynamicPartials

dynamicPartials?: boolean

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

+

OptionaldynamicPartials

dynamicPartials?: boolean

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

Optionalextname

extname?: 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 "".

Optionalfs

fs?: FS

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

-

Optionalglobals

globals?: object

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

-

Optionalgreedy

greedy?: boolean

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

-

OptionaljekyllInclude

jekyllInclude?: boolean

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

+

Optionalglobals

globals?: object

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

+

Optionalgreedy

greedy?: boolean

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

+

OptionaljekyllInclude

jekyllInclude?: boolean

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

OptionaljekyllWhere

jekyllWhere?: boolean

Use jekyll style where filter, enables array item match. Defaults to false.

OptionaljsTruthy

jsTruthy?: boolean

Use JavaScript Truthiness. Defaults to false.

OptionalkeepOutputType

keepOutputType?: boolean

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

-

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

-

Optionallayouts

layouts?: string | string[]

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

+

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

+

Optionallayouts

layouts?: string | string[]

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

OptionallenientIf

lenientIf?: boolean

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. *

-

Optionallocale

locale?: string

Default locale, will be used by date filter. Defaults to system locale.

-

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

-

Optionaloperators

operators?: Operators

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

-

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

-

OptionaloutputDelimiterLeft

outputDelimiterLeft?: string

The left delimiter for liquid outputs. *

-

OptionaloutputDelimiterRight

outputDelimiterRight?: string

The right delimiter for liquid outputs. *

-

OptionaloutputEscape

outputEscape?: OutputEscapeOption

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.

-

OptionalownPropertyOnly

ownPropertyOnly?: boolean

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

-

OptionalparseLimit

parseLimit?: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

-

Optionalpartials

partials?: string | string[]

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

+

Optionallocale

locale?: string

Default locale, will be used by date filter. Defaults to system locale.

+

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

+

Optionaloperators

operators?: Operators

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

+

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

+

OptionaloutputDelimiterLeft

outputDelimiterLeft?: string

The left delimiter for liquid outputs. *

+

OptionaloutputDelimiterRight

outputDelimiterRight?: string

The right delimiter for liquid outputs. *

+

OptionaloutputEscape

outputEscape?: OutputEscapeOption

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.

+

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Hide scope variables from prototypes, useful when you're passing a not sanitized object into LiquidJS or need to hide prototypes from templates. +This only applies to property/index access on scope objects. Filter transforms and iteration operate on the resolved value with standard JavaScript semantics, so prototype-inherited array indices may still be surfaced by them.

+

OptionalparseLimit

parseLimit?: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

+

Optionalpartials

partials?: string | string[]

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

OptionalpreserveTimezones

preserveTimezones?: boolean

Whether input strings to date filter preserve the given timezone *

-

OptionalrelativeReference

relativeReference?: boolean

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.

+

OptionalrelativeReference

relativeReference?: boolean

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.

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

-

Optionalroot

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 ["."]

+

Optionalroot

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 ["."]

OptionalstrictFilters

strictFilters?: boolean

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.

OptionalstrictVariables

strictVariables?: boolean

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.

OptionaltagDelimiterLeft

tagDelimiterLeft?: string

The left delimiter for liquid tags. *

-

OptionaltagDelimiterRight

tagDelimiterRight?: string

The right delimiter for liquid tags. *

-

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

-

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

-

OptionaltrimOutputLeft

trimOutputLeft?: boolean

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

-

OptionaltrimOutputRight

trimOutputRight?: boolean

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

-

OptionaltrimTagLeft

trimTagLeft?: boolean

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

-

OptionaltrimTagRight

trimTagRight?: boolean

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

-

Settings

Member Visibility

On This Page

Properties
+

OptionaltagDelimiterRight

tagDelimiterRight?: string

The right delimiter for liquid tags. *

+

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

+

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

+

OptionaltrimOutputLeft

trimOutputLeft?: boolean

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

+

OptionaltrimOutputRight

trimOutputRight?: boolean

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

+

OptionaltrimTagLeft

trimTagLeft?: boolean

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

+

OptionaltrimTagRight

trimTagRight?: boolean

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

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/RenderFileOptions.html b/api/interfaces/RenderFileOptions.html index 7705173cd..600dfcf4d 100644 --- a/api/interfaces/RenderFileOptions.html +++ b/api/interfaces/RenderFileOptions.html @@ -1,4 +1,4 @@ -RenderFileOptions | liquidjs

Interface RenderFileOptions

interface RenderFileOptions {
    globals?: object;
    lookupType?: LookupType;
    memoryLimit?: number;
    ownPropertyOnly?: boolean;
    renderLimit?: number;
    strictVariables?: boolean;
    sync?: boolean;
    templateLimit?: number;
}

Hierarchy (view full)

Properties

globals? +RenderFileOptions | liquidjs

Interface RenderFileOptions

interface RenderFileOptions {
    globals?: object;
    lookupType?: LookupType;
    memoryLimit?: number;
    ownPropertyOnly?: boolean;
    renderLimit?: number;
    strictVariables?: boolean;
    sync?: boolean;
    templateLimit?: number;
}

Hierarchy (view full)

Properties

globals? lookupType? memoryLimit? ownPropertyOnly? @@ -7,10 +7,10 @@ sync? templateLimit?

Properties

Optionalglobals

globals?: object

Same as globals on LiquidOptions, but only for current render() call

-

OptionallookupType

lookupType?: LookupType

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue..

-

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Same as ownPropertyOnly on LiquidOptions, but only for current render() call

-

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

-

OptionalstrictVariables

strictVariables?: boolean

Same as strictVariables on LiquidOptions, but only for current render() call

-

Optionalsync

sync?: boolean

This call is sync or async? It's used by Liquid internal methods, you'll not need this.

-

OptionaltemplateLimit

templateLimit?: number

For DoS handling, limit total renders of tag/HTML/output in one render() call. A typical PC can handle 1e5 renders of typical templates per second.

-

Settings

Member Visibility

On This Page

Properties
+

OptionallookupType

lookupType?: LookupType

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue..

+

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Same as ownPropertyOnly on LiquidOptions, but only for current render() call

+

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

+

OptionalstrictVariables

strictVariables?: boolean

Same as strictVariables on LiquidOptions, but only for current render() call

+

Optionalsync

sync?: boolean

This call is sync or async? It's used by Liquid internal methods, you'll not need this.

+

OptionaltemplateLimit

templateLimit?: number

For DoS handling, limit total renders of tag/HTML/output in one render() call. A typical PC can handle 1e5 renders of typical templates per second.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/RenderOptions.html b/api/interfaces/RenderOptions.html index 06af89ae6..1730c197c 100644 --- a/api/interfaces/RenderOptions.html +++ b/api/interfaces/RenderOptions.html @@ -1,4 +1,4 @@ -RenderOptions | liquidjs

Interface RenderOptions

interface RenderOptions {
    globals?: object;
    memoryLimit?: number;
    ownPropertyOnly?: boolean;
    renderLimit?: number;
    strictVariables?: boolean;
    sync?: boolean;
    templateLimit?: number;
}

Hierarchy (view full)

Properties

globals? +RenderOptions | liquidjs

Interface RenderOptions

interface RenderOptions {
    globals?: object;
    memoryLimit?: number;
    ownPropertyOnly?: boolean;
    renderLimit?: number;
    strictVariables?: boolean;
    sync?: boolean;
    templateLimit?: number;
}

Hierarchy (view full)

Properties

globals? memoryLimit? ownPropertyOnly? renderLimit? @@ -6,10 +6,10 @@ sync? templateLimit?

Properties

Optionalglobals

globals?: object

Same as globals on LiquidOptions, but only for current render() call

-

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue..

-

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Same as ownPropertyOnly on LiquidOptions, but only for current render() call

-

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

-

OptionalstrictVariables

strictVariables?: boolean

Same as strictVariables on LiquidOptions, but only for current render() call

-

Optionalsync

sync?: boolean

This call is sync or async? It's used by Liquid internal methods, you'll not need this.

-

OptionaltemplateLimit

templateLimit?: number

For DoS handling, limit total renders of tag/HTML/output in one render() call. A typical PC can handle 1e5 renders of typical templates per second.

-

Settings

Member Visibility

On This Page

Properties
+

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue..

+

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Same as ownPropertyOnly on LiquidOptions, but only for current render() call

+

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

+

OptionalstrictVariables

strictVariables?: boolean

Same as strictVariables on LiquidOptions, but only for current render() call

+

Optionalsync

sync?: boolean

This call is sync or async? It's used by Liquid internal methods, you'll not need this.

+

OptionaltemplateLimit

templateLimit?: number

For DoS handling, limit total renders of tag/HTML/output in one render() call. A typical PC can handle 1e5 renders of typical templates per second.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/_internal_.NormalizedFullOptions.html b/api/interfaces/_internal_.NormalizedFullOptions.html index b88b32816..778ea770c 100644 --- a/api/interfaces/_internal_.NormalizedFullOptions.html +++ b/api/interfaces/_internal_.NormalizedFullOptions.html @@ -1,4 +1,4 @@ -NormalizedFullOptions | liquidjs

Interface NormalizedFullOptions

interface NormalizedFullOptions {
    cache?: LiquidCache;
    catchAllErrors?: boolean;
    dateFormat: string;
    dynamicPartials: boolean;
    extname: string;
    fs: FS;
    globals: object;
    greedy: boolean;
    jekyllInclude: boolean;
    jekyllWhere?: boolean;
    jsTruthy: boolean;
    keepOutputType: boolean;
    keyValueSeparator?: string;
    layouts: string[];
    lenientIf: boolean;
    locale: string;
    memoryLimit: number;
    operators: Operators;
    orderedFilterParameters?: boolean;
    outputDelimiterLeft: string;
    outputDelimiterRight: string;
    outputEscape?: OutputEscape;
    ownPropertyOnly: boolean;
    parseLimit: number;
    partials: string[];
    preserveTimezones: boolean;
    relativeReference: boolean;
    renderLimit: number;
    root: string[];
    strictFilters: boolean;
    strictVariables: boolean;
    tagDelimiterLeft: string;
    tagDelimiterRight: string;
    templates?: {
        [key: string]: string;
    };
    timezoneOffset?: string | number;
    trimOutputLeft: boolean;
    trimOutputRight: boolean;
    trimTagLeft: boolean;
    trimTagRight: boolean;
}

Hierarchy (view full)

Properties

cache? +NormalizedFullOptions | liquidjs

Interface NormalizedFullOptions

interface NormalizedFullOptions {
    cache?: LiquidCache;
    catchAllErrors?: boolean;
    dateFormat: string;
    dynamicPartials: boolean;
    extname: string;
    fs: FS;
    globals: object;
    greedy: boolean;
    jekyllInclude: boolean;
    jekyllWhere?: boolean;
    jsTruthy: boolean;
    keepOutputType: boolean;
    keyValueSeparator?: string;
    layouts: string[];
    lenientIf: boolean;
    locale: string;
    memoryLimit: number;
    operators: Operators;
    orderedFilterParameters?: boolean;
    outputDelimiterLeft: string;
    outputDelimiterRight: string;
    outputEscape?: OutputEscape;
    ownPropertyOnly: boolean;
    parseLimit: number;
    partials: string[];
    preserveTimezones: boolean;
    relativeReference: boolean;
    renderLimit: number;
    root: string[];
    strictFilters: boolean;
    strictVariables: boolean;
    tagDelimiterLeft: string;
    tagDelimiterRight: string;
    templates?: {
        [key: string]: string;
    };
    timezoneOffset?: string | number;
    trimOutputLeft: boolean;
    trimOutputRight: boolean;
    trimTagLeft: boolean;
    trimTagRight: boolean;
}

Hierarchy (view full)

Properties

cache? catchAllErrors? dateFormat dynamicPartials @@ -38,42 +38,43 @@ trimTagLeft trimTagRight

Properties

Optionalcache

cache?: LiquidCache

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

-

OptionalcatchAllErrors

catchAllErrors?: boolean

Catch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.

+

OptionalcatchAllErrors

catchAllErrors?: boolean

Catch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.

dateFormat

dateFormat: string

Default date format to use if the date filter doesn't include a format. Defaults to %A, %B %-e, %Y at %-l:%M %P %z.

-

dynamicPartials

dynamicPartials: boolean

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

-

extname

extname: 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 "".

-

fs

fs: FS

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

-

globals

globals: object

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

-

greedy

greedy: boolean

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

-

jekyllInclude

jekyllInclude: boolean

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

-

OptionaljekyllWhere

jekyllWhere?: boolean

Use jekyll style where filter, enables array item match. Defaults to false.

+

dynamicPartials

dynamicPartials: boolean

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

+

extname

extname: 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 "".

+

fs

fs: FS

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

+

globals

globals: object

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

+

greedy

greedy: boolean

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

+

jekyllInclude

jekyllInclude: boolean

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

+

OptionaljekyllWhere

jekyllWhere?: boolean

Use jekyll style where filter, enables array item match. Defaults to false.

jsTruthy

jsTruthy: boolean

Use JavaScript Truthiness. Defaults to false.

-

keepOutputType

keepOutputType: boolean

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

-

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

-

layouts

layouts: string[]

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

-

lenientIf

lenientIf: boolean

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. *

-

locale

locale: string

Default locale, will be used by date filter. Defaults to system locale.

-

memoryLimit

memoryLimit: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

-

operators

operators: Operators

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

-

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

-

outputDelimiterLeft

outputDelimiterLeft: string

The left delimiter for liquid outputs. *

-

outputDelimiterRight

outputDelimiterRight: string

The right delimiter for liquid outputs. *

-

OptionaloutputEscape

outputEscape?: OutputEscape

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.

-

ownPropertyOnly

ownPropertyOnly: boolean

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

-

parseLimit

parseLimit: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

-

partials

partials: string[]

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

-

preserveTimezones

preserveTimezones: boolean

Whether input strings to date filter preserve the given timezone *

-

relativeReference

relativeReference: boolean

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.

-

renderLimit

renderLimit: number

For DoS handling, limit total time (in ms) for each render() call.

-

root

root: 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 ["."]

-

strictFilters

strictFilters: boolean

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.

-

strictVariables

strictVariables: boolean

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.

-

tagDelimiterLeft

tagDelimiterLeft: string

The left delimiter for liquid tags. *

-

tagDelimiterRight

tagDelimiterRight: string

The right delimiter for liquid tags. *

-

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

-

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

-

trimOutputLeft

trimOutputLeft: boolean

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

-

trimOutputRight

trimOutputRight: boolean

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

-

trimTagLeft

trimTagLeft: boolean

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

-

trimTagRight

trimTagRight: boolean

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

-

Settings

Member Visibility

On This Page

Properties
+

keepOutputType

keepOutputType: boolean

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

+

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

+

layouts

layouts: string[]

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

+

lenientIf

lenientIf: boolean

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. *

+

locale

locale: string

Default locale, will be used by date filter. Defaults to system locale.

+

memoryLimit

memoryLimit: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

+

operators

operators: Operators

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

+

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

+

outputDelimiterLeft

outputDelimiterLeft: string

The left delimiter for liquid outputs. *

+

outputDelimiterRight

outputDelimiterRight: string

The right delimiter for liquid outputs. *

+

OptionaloutputEscape

outputEscape?: OutputEscape

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.

+

ownPropertyOnly

ownPropertyOnly: boolean

Hide scope variables from prototypes, useful when you're passing a not sanitized object into LiquidJS or need to hide prototypes from templates. +This only applies to property/index access on scope objects. Filter transforms and iteration operate on the resolved value with standard JavaScript semantics, so prototype-inherited array indices may still be surfaced by them.

+

parseLimit

parseLimit: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

+

partials

partials: string[]

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

+

preserveTimezones

preserveTimezones: boolean

Whether input strings to date filter preserve the given timezone *

+

relativeReference

relativeReference: boolean

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.

+

renderLimit

renderLimit: number

For DoS handling, limit total time (in ms) for each render() call.

+

root

root: 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 ["."]

+

strictFilters

strictFilters: boolean

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.

+

strictVariables

strictVariables: boolean

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.

+

tagDelimiterLeft

tagDelimiterLeft: string

The left delimiter for liquid tags. *

+

tagDelimiterRight

tagDelimiterRight: string

The right delimiter for liquid tags. *

+

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

+

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

+

trimOutputLeft

trimOutputLeft: boolean

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

+

trimOutputRight

trimOutputRight: boolean

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

+

trimTagLeft

trimTagLeft: boolean

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

+

trimTagRight

trimTagRight: boolean

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

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/_internal_.NormalizedOptions.html b/api/interfaces/_internal_.NormalizedOptions.html index 1254d94fb..c12d4bf2f 100644 --- a/api/interfaces/_internal_.NormalizedOptions.html +++ b/api/interfaces/_internal_.NormalizedOptions.html @@ -1,4 +1,4 @@ -NormalizedOptions | liquidjs

Interface NormalizedOptions

interface NormalizedOptions {
    cache?: LiquidCache;
    catchAllErrors?: boolean;
    dateFormat?: string;
    dynamicPartials?: boolean;
    extname?: string;
    fs?: FS;
    globals?: object;
    greedy?: boolean;
    jekyllInclude?: boolean;
    jekyllWhere?: boolean;
    jsTruthy?: boolean;
    keepOutputType?: boolean;
    keyValueSeparator?: string;
    layouts?: string[];
    lenientIf?: boolean;
    locale?: string;
    memoryLimit?: number;
    operators?: Operators;
    orderedFilterParameters?: boolean;
    outputDelimiterLeft?: string;
    outputDelimiterRight?: string;
    outputEscape?: OutputEscape;
    ownPropertyOnly?: boolean;
    parseLimit?: number;
    partials?: string[];
    preserveTimezones?: boolean;
    relativeReference?: boolean;
    renderLimit?: number;
    root?: string[];
    strictFilters?: boolean;
    strictVariables?: boolean;
    tagDelimiterLeft?: string;
    tagDelimiterRight?: string;
    templates?: {
        [key: string]: string;
    };
    timezoneOffset?: string | number;
    trimOutputLeft?: boolean;
    trimOutputRight?: boolean;
    trimTagLeft?: boolean;
    trimTagRight?: boolean;
}

Hierarchy (view full)

Properties

cache? +NormalizedOptions | liquidjs

Interface NormalizedOptions

interface NormalizedOptions {
    cache?: LiquidCache;
    catchAllErrors?: boolean;
    dateFormat?: string;
    dynamicPartials?: boolean;
    extname?: string;
    fs?: FS;
    globals?: object;
    greedy?: boolean;
    jekyllInclude?: boolean;
    jekyllWhere?: boolean;
    jsTruthy?: boolean;
    keepOutputType?: boolean;
    keyValueSeparator?: string;
    layouts?: string[];
    lenientIf?: boolean;
    locale?: string;
    memoryLimit?: number;
    operators?: Operators;
    orderedFilterParameters?: boolean;
    outputDelimiterLeft?: string;
    outputDelimiterRight?: string;
    outputEscape?: OutputEscape;
    ownPropertyOnly?: boolean;
    parseLimit?: number;
    partials?: string[];
    preserveTimezones?: boolean;
    relativeReference?: boolean;
    renderLimit?: number;
    root?: string[];
    strictFilters?: boolean;
    strictVariables?: boolean;
    tagDelimiterLeft?: string;
    tagDelimiterRight?: string;
    templates?: {
        [key: string]: string;
    };
    timezoneOffset?: string | number;
    trimOutputLeft?: boolean;
    trimOutputRight?: boolean;
    trimTagLeft?: boolean;
    trimTagRight?: boolean;
}

Hierarchy (view full)

Properties

cache? catchAllErrors? dateFormat? dynamicPartials? @@ -38,42 +38,43 @@ trimTagLeft? trimTagRight?

Properties

Optionalcache

cache?: LiquidCache

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

-

OptionalcatchAllErrors

catchAllErrors?: boolean

Catch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.

+

OptionalcatchAllErrors

catchAllErrors?: boolean

Catch all errors instead of exit upon one. Please note that render errors won't be reached when parse fails.

OptionaldateFormat

dateFormat?: string

Default date format to use if the date filter doesn't include a format. Defaults to %A, %B %-e, %Y at %-l:%M %P %z.

-

OptionaldynamicPartials

dynamicPartials?: boolean

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

+

OptionaldynamicPartials

dynamicPartials?: boolean

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

Optionalextname

extname?: 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 "".

Optionalfs

fs?: FS

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

-

Optionalglobals

globals?: object

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

-

Optionalgreedy

greedy?: boolean

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

-

OptionaljekyllInclude

jekyllInclude?: boolean

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

+

Optionalglobals

globals?: object

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

+

Optionalgreedy

greedy?: boolean

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

+

OptionaljekyllInclude

jekyllInclude?: boolean

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

OptionaljekyllWhere

jekyllWhere?: boolean

Use jekyll style where filter, enables array item match. Defaults to false.

OptionaljsTruthy

jsTruthy?: boolean

Use JavaScript Truthiness. Defaults to false.

OptionalkeepOutputType

keepOutputType?: boolean

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

-

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

-

Optionallayouts

layouts?: string[]

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

-

OptionallenientIf

lenientIf?: boolean

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. *

-

Optionallocale

locale?: string

Default locale, will be used by date filter. Defaults to system locale.

-

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

-

Optionaloperators

operators?: Operators

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

-

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

-

OptionaloutputDelimiterLeft

outputDelimiterLeft?: string

The left delimiter for liquid outputs. *

-

OptionaloutputDelimiterRight

outputDelimiterRight?: string

The right delimiter for liquid outputs. *

-

OptionaloutputEscape

outputEscape?: OutputEscape

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.

-

OptionalownPropertyOnly

ownPropertyOnly?: boolean

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

-

OptionalparseLimit

parseLimit?: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

-

Optionalpartials

partials?: string[]

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

-

OptionalpreserveTimezones

preserveTimezones?: boolean

Whether input strings to date filter preserve the given timezone *

-

OptionalrelativeReference

relativeReference?: boolean

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.

+

OptionalkeyValueSeparator

keyValueSeparator?: string

keyValue separator

+

Optionallayouts

layouts?: string[]

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

+

OptionallenientIf

lenientIf?: boolean

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. *

+

Optionallocale

locale?: string

Default locale, will be used by date filter. Defaults to system locale.

+

OptionalmemoryLimit

memoryLimit?: number

For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.

+

Optionaloperators

operators?: Operators

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

+

OptionalorderedFilterParameters

orderedFilterParameters?: boolean

Respect parameter order when using filters like "for ... reversed limit", Defaults to false.

+

OptionaloutputDelimiterLeft

outputDelimiterLeft?: string

The left delimiter for liquid outputs. *

+

OptionaloutputDelimiterRight

outputDelimiterRight?: string

The right delimiter for liquid outputs. *

+

OptionaloutputEscape

outputEscape?: OutputEscape

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.

+

OptionalownPropertyOnly

ownPropertyOnly?: boolean

Hide scope variables from prototypes, useful when you're passing a not sanitized object into LiquidJS or need to hide prototypes from templates. +This only applies to property/index access on scope objects. Filter transforms and iteration operate on the resolved value with standard JavaScript semantics, so prototype-inherited array indices may still be surfaced by them.

+

OptionalparseLimit

parseLimit?: number

For DoS handling, limit total length of templates parsed in one parse() call. A typical PC can handle 1e8 (100M) characters without issues.

+

Optionalpartials

partials?: string[]

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

+

OptionalpreserveTimezones

preserveTimezones?: boolean

Whether input strings to date filter preserve the given timezone *

+

OptionalrelativeReference

relativeReference?: boolean

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.

OptionalrenderLimit

renderLimit?: number

For DoS handling, limit total time (in ms) for each render() call.

-

Optionalroot

root?: 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 ["."]

-

OptionalstrictFilters

strictFilters?: boolean

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.

+

Optionalroot

root?: 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 ["."]

+

OptionalstrictFilters

strictFilters?: boolean

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.

OptionalstrictVariables

strictVariables?: boolean

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.

OptionaltagDelimiterLeft

tagDelimiterLeft?: string

The left delimiter for liquid tags. *

-

OptionaltagDelimiterRight

tagDelimiterRight?: string

The right delimiter for liquid tags. *

-

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

-

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

-

OptionaltrimOutputLeft

trimOutputLeft?: boolean

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

-

OptionaltrimOutputRight

trimOutputRight?: boolean

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

-

OptionaltrimTagLeft

trimTagLeft?: boolean

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

-

OptionaltrimTagRight

trimTagRight?: boolean

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

-

Settings

Member Visibility

On This Page

Properties
+

OptionaltagDelimiterRight

tagDelimiterRight?: string

The right delimiter for liquid tags. *

+

Optionaltemplates

templates?: {
    [key: string]: string;
}

Render from an in-memory templates mapping instead of the file system. When templates is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as fs, root, partials, layouts, and relativeReference are effectively bypassed for those lookups.

+

OptionaltimezoneOffset

timezoneOffset?: string | number

JavaScript timezone name or timezoneOffset for date filter, default to local time. That means if you're in Australia (UTC+10), it'll default to -600 or Australia/Lindeman

+

OptionaltrimOutputLeft

trimOutputLeft?: boolean

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

+

OptionaltrimOutputRight

trimOutputRight?: boolean

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

+

OptionaltrimTagLeft

trimTagLeft?: boolean

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

+

OptionaltrimTagRight

trimTagRight?: boolean

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

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/variables/defaultOptions.html b/api/variables/defaultOptions.html index de8a95f56..f3f0345f8 100644 --- a/api/variables/defaultOptions.html +++ b/api/variables/defaultOptions.html @@ -1 +1 @@ -defaultOptions | liquidjs

Variable defaultOptionsConst

defaultOptions: NormalizedFullOptions = ...

Settings

Member Visibility
+defaultOptions | liquidjs

Variable defaultOptionsConst

defaultOptions: NormalizedFullOptions = ...

Settings

Member Visibility
diff --git a/filters/abs.html b/filters/abs.html index 2340f1027..73900797f 100644 --- a/filters/abs.html +++ b/filters/abs.html @@ -121,7 +121,7 @@ diff --git a/filters/append.html b/filters/append.html index 57643dd01..8067dc8d5 100644 --- a/filters/append.html +++ b/filters/append.html @@ -117,7 +117,7 @@ website.com/index.html