mirror of
https://github.com/harttle/liquidjs.git
synced 2026-09-15 12:20:40 -07:00
303 lines
43 KiB
HTML
303 lines
43 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head prefix="og: http://ogp.me/ns#">
|
||
<meta charset="utf-8">
|
||
<title>Interface: LiquidOptions | LiquidJS</title>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="description" content="LiquidJS is a simple, expressive and safe Shopify / Github Pages compatible template engine in pure JavaScript.">
|
||
<link rel="dns-prefetch" href="https://cdn.jsdelivr.net/">
|
||
<link rel="manifest" href="/manifest.json">
|
||
<!-- Canonical links -->
|
||
<link rel="canonical" href="https://liquidjs.com/api/interfaces/liquid_options_.liquidoptions.html">
|
||
<!-- Alternative links -->
|
||
|
||
|
||
<link rel="alternative" hreflang="en" href="https://liquidjs.com/api/interfaces/liquid_options_.liquidoptions">
|
||
|
||
<link rel="alternative" hreflang="zh-cn" href="https://liquidjs.com/zh-cn/api/interfaces/liquid_options_.liquidoptions">
|
||
|
||
|
||
<!-- Icon -->
|
||
<link rel="apple-touch-icon" sizes="57x57" href="../../icon/apple-touch-icon-57x57.png">
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../../icon/apple-touch-icon-114x114.png">
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../../icon/apple-touch-icon-72x72.png">
|
||
<link rel="apple-touch-icon" sizes="144x144" href="../../icon/apple-touch-icon-144x144.png">
|
||
<link rel="apple-touch-icon" sizes="60x60" href="../../icon/apple-touch-icon-60x60.png">
|
||
<link rel="apple-touch-icon" sizes="120x120" href="../../icon/apple-touch-icon-120x120.png">
|
||
<link rel="apple-touch-icon" sizes="76x76" href="../../icon/apple-touch-icon-76x76.png">
|
||
<link rel="apple-touch-icon" sizes="152x152" href="../../icon/apple-touch-icon-152x152.png">
|
||
<link rel="icon" type="image/png" href="../../icon/favicon-196x196.png" sizes="196x196">
|
||
<link rel="icon" type="image/png" href="../../icon/favicon-160x160.png" sizes="160x160">
|
||
<link rel="icon" type="image/png" href="../../icon/favicon-96x96.png" sizes="96x96">
|
||
<link rel="icon" type="image/png" href="../../icon/favicon-16x16.png" sizes="16x16">
|
||
<link rel="icon" type="image/png" href="../../icon/favicon-32x32.png" sizes="32x32">
|
||
<meta name="msapplication-TileColor" content="#2f83cd">
|
||
<meta name="msapplication-TileImage" content="../../icon/mstile-144x144.png">
|
||
|
||
<link rel="stylesheet" href="../../css/navy.css">
|
||
|
||
<link rel="alternate" href="../../atom.xml" title="LiquidJS" type="application/atom+xml">
|
||
<meta name="generator" content="Hexo 5.4.0"></head>
|
||
|
||
<body>
|
||
<div id="container">
|
||
<header id="header" class="wrapper">
|
||
<div id="header-inner" class="inner">
|
||
<h1 id="logo-wrap">
|
||
<a href="../../index.html" id="logo">LiquidJS</a>
|
||
</h1>
|
||
<nav id="main-nav">
|
||
<a href="../../tutorials/intro-to-liquid.html" class="main-nav-link">Tutorials</a><a href="../../tags/overview.html" class="main-nav-link">Tags</a><a href="../../filters/overview.html" class="main-nav-link">Filters</a><a href="../../playground.html" class="main-nav-link">Playground</a><a href="../../api/classes/liquid_.liquid.html" class="main-nav-link">API</a>
|
||
<div id="search-input-wrap">
|
||
<i id="search-input-icon" class="icon-search"></i>
|
||
<input type="search" id="search-input" placeholder="Search...">
|
||
</div>
|
||
</nav>
|
||
<div class="main-nav-link icon-nav-link">
|
||
<label><i class="icon-network"></i> <span class="icon-nav-title">English</span></label>
|
||
<select id="lang-select" data-canonical="api/interfaces/liquid_options_.liquidoptions.html">
|
||
|
||
<option value="en" selected>English</option>
|
||
|
||
<option value="zh-cn">简体中文</option>
|
||
|
||
</select>
|
||
</div>
|
||
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs" class="main-nav-link icon-nav-link"><i class="icon-github"></i> <span class="icon-nav-title">Github</span></a>
|
||
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://opencollective.com/liquidjs" class="main-nav-link icon-nav-link"><i class="icon-opencollective"></i> <span class="icon-nav-title">Support</span></a>
|
||
<a id="mobile-nav-toggle">
|
||
<span class="mobile-nav-toggle-bar"></span>
|
||
<span class="mobile-nav-toggle-bar"></span>
|
||
<span class="mobile-nav-toggle-bar"></span>
|
||
</a>
|
||
</div>
|
||
</header>
|
||
|
||
<div id="content-wrap">
|
||
<div id="content" class="wrapper">
|
||
<div id="content-inner">
|
||
<aside id="sidebar" role="navigation">
|
||
<div class="inner">
|
||
<strong class="sidebar-title">Quick Entry</strong><a href="../classes/liquid_.liquid.html" class="sidebar-link">Liquid</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="sidebar-link">LiquidOptions</a><a href="../interfaces/fs_fs_.fs.html" class="sidebar-link">FS</a><a href="../interfaces/cache_cache_.cache.html" class="sidebar-link">Cache</a><strong class="sidebar-title">Classes</strong><a href="../classes/drop_blank_drop_.blankdrop.html" class="sidebar-link">BlankDrop</a><a href="../classes/context_context_.context.html" class="sidebar-link">Context</a><a href="../classes/tokens_delimited_token_.delimitedtoken.html" class="sidebar-link">DelimitedToken</a><a href="../classes/drop_drop_.drop.html" class="sidebar-link">Drop</a><a href="../classes/drop_empty_drop_.emptydrop.html" class="sidebar-link">EmptyDrop</a><a href="../classes/render_expression_.expression.html" class="sidebar-link">Expression</a><a href="../classes/tokens_filter_token_.filtertoken.html" class="sidebar-link">FilterToken</a><a href="../classes/drop_forloop_drop_.forloopdrop.html" class="sidebar-link">ForloopDrop</a><a href="../classes/tokens_html_token_.htmltoken.html" class="sidebar-link">HTMLToken</a><a href="../classes/tokens_hash_token_.hashtoken.html" class="sidebar-link">HashToken</a><a href="../classes/cache_lru_.lru.html" class="sidebar-link">LRU</a><a href="../classes/liquid_.liquid.html" class="sidebar-link">Liquid</a><a href="../classes/tokens_literal_token_.literaltoken.html" class="sidebar-link">LiteralToken</a><a href="../classes/drop_null_drop_.nulldrop.html" class="sidebar-link">NullDrop</a><a href="../classes/tokens_number_token_.numbertoken.html" class="sidebar-link">NumberToken</a><a href="../classes/tokens_operator_token_.operatortoken.html" class="sidebar-link">OperatorToken</a><a href="../classes/tokens_output_token_.outputtoken.html" class="sidebar-link">OutputToken</a><a href="../classes/util_error_.parseerror.html" class="sidebar-link">ParseError</a><a href="../classes/parser_parse_stream_.parsestream.html" class="sidebar-link">ParseStream</a><a href="../classes/parser_parser_.parser.html" class="sidebar-link">Parser</a><a href="../classes/tokens_property_access_token_.propertyaccesstoken.html" class="sidebar-link">PropertyaccessToken</a><a href="../classes/tokens_quoted_token_.quotedtoken.html" class="sidebar-link">QuotedToken</a><a href="../classes/tokens_range_token_.rangetoken.html" class="sidebar-link">RangeToken</a><a href="../classes/render_render_.render.html" class="sidebar-link">Render</a><a href="../classes/util_error_.rendererror.html" class="sidebar-link">RenderError</a><a href="../classes/drop_tablerowloop_drop_.tablerowloopdrop.html" class="sidebar-link">TablerowloopDrop</a><a href="../classes/tokens_tag_token_.tagtoken.html" class="sidebar-link">TagToken</a><a href="../classes/tokens_token_.token.html" class="sidebar-link">Token</a><a href="../classes/util_error_.tokenizationerror.html" class="sidebar-link">TokenizationError</a><a href="../classes/parser_tokenizer_.tokenizer.html" class="sidebar-link">Tokenizer</a><a href="../classes/tokens_word_token_.wordtoken.html" class="sidebar-link">WordToken</a><strong class="sidebar-title">Enums</strong><a href="../enums/context_block_mode_.blockmode.html" class="sidebar-link">BlockMode</a><a href="../enums/parser_token_kind_.tokenkind.html" class="sidebar-link">TokenKind</a><strong class="sidebar-title">Interfaces</strong><a href="../interfaces/cache_cache_.cache.html" class="sidebar-link">Cache</a><a href="../interfaces/template_filter_filter_impl_options_.filterimploptions.html" class="sidebar-link">FilterImplOptions</a><a href="../interfaces/fs_fs_.fs.html" class="sidebar-link">FS</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="sidebar-link">LiquidOptions</a><a href="../interfaces/liquid_options_.normalizedfulloptions.html" class="sidebar-link">NormalizedFullOptions</a><a href="../interfaces/context_scope_.plainobject.html" class="sidebar-link">PlainObject</a><a href="../interfaces/template_tag_tag_impl_options_.tagimploptions.html" class="sidebar-link">TagImplOptions</a>
|
||
</div>
|
||
</aside>
|
||
<article class="article-container" itemscope itemtype="http://schema.org/Article">
|
||
<div class="article-inner">
|
||
<div class="article">
|
||
<div class="inner">
|
||
<header class="article-header">
|
||
<h1 class="article-title" itemprop="name">Interface: LiquidOptions</h1>
|
||
|
||
<a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/issues/new?title=docs:&body=URL: https%3A%2F%2Fliquidjs.com%2Fapi%2Finterfaces%2Fliquid_options_.liquidoptions.html&labels=docs" class="article-edit-link" title="Report problems"><i class="icon-chat-bubble-dots"></i></a>
|
||
|
||
</header>
|
||
<div class="article-content" itemprop="articleBody">
|
||
<h2 id="Hierarchy" class="article-heading"><a href="#Hierarchy" class="headerlink" title="Hierarchy"></a>Hierarchy<a class="article-anchor" href="#Hierarchy" aria-hidden="true"></a></h2><ul>
|
||
<li><p><strong>LiquidOptions</strong></p>
|
||
<p>↳ <a href="liquid_options_.normalizedoptions.html">NormalizedOptions</a></p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="Properties" class="article-heading"><a href="#Properties" class="headerlink" title="Properties"></a>Properties<a class="article-anchor" href="#Properties" aria-hidden="true"></a></h2><h3 id="Optional-cache" class="article-heading"><a href="#Optional-cache" class="headerlink" title="Optional cache"></a><code>Optional</code> cache<a class="article-anchor" href="#Optional-cache" aria-hidden="true"></a></h3><p>• <strong>cache</strong>? : <em>boolean | number | <a href="../modules/cache_cache_.html#liquidcache">LiquidCache</a></em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L33">src/liquid-options.ts:33</a></em></p>
|
||
<p>Whether or not to cache resolved templates. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-dynamicPartials" class="article-heading"><a href="#Optional-dynamicPartials" class="headerlink" title="Optional dynamicPartials"></a><code>Optional</code> dynamicPartials<a class="article-anchor" href="#Optional-dynamicPartials" aria-hidden="true"></a></h3><p>• <strong>dynamicPartials</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L37">src/liquid-options.ts:37</a></em></p>
|
||
<p>If set, treat the <code>filepath</code> parameter in <code>{%include filepath %}</code> and <code>{%layout filepath%}</code> as a variable, otherwise as a literal value. Defaults to <code>true</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-extname" class="article-heading"><a href="#Optional-extname" class="headerlink" title="Optional extname"></a><code>Optional</code> extname<a class="article-anchor" href="#Optional-extname" aria-hidden="true"></a></h3><p>• <strong>extname</strong>? : <em>undefined | string</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L31">src/liquid-options.ts:31</a></em></p>
|
||
<p>Add a extname (if filepath doesn’t include one) before template file lookup. Eg: setting to <code>".html"</code> will allow including file by basename. Defaults to <code>""</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-fs" class="article-heading"><a href="#Optional-fs" class="headerlink" title="Optional fs"></a><code>Optional</code> fs<a class="article-anchor" href="#Optional-fs" aria-hidden="true"></a></h3><p>• <strong>fs</strong>? : <em><a href="fs_fs_.fs.html">FS</a></em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L69">src/liquid-options.ts:69</a></em></p>
|
||
<p><code>fs</code> is used to override the default file-system module with a custom implementation.</p>
|
||
<hr>
|
||
<h3 id="Optional-globals" class="article-heading"><a href="#Optional-globals" class="headerlink" title="Optional globals"></a><code>Optional</code> globals<a class="article-anchor" href="#Optional-globals" aria-hidden="true"></a></h3><p>• <strong>globals</strong>? : <em>undefined | object</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L71">src/liquid-options.ts:71</a></em></p>
|
||
<p>the global scope passed down to all partial and layout templates, i.e. templates included by <code>include</code>, <code>layout</code> and <code>render</code> tags.</p>
|
||
<hr>
|
||
<h3 id="Optional-greedy" class="article-heading"><a href="#Optional-greedy" class="headerlink" title="Optional greedy"></a><code>Optional</code> greedy<a class="article-anchor" href="#Optional-greedy" aria-hidden="true"></a></h3><p>• <strong>greedy</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L67">src/liquid-options.ts:67</a></em></p>
|
||
<p>Whether <code>trim*Left</code>/<code>trim*Right</code> is greedy. When set to <code>true</code>, all consecutive blank characters including <code>\n</code> will be trimed regardless of line breaks. Defaults to <code>true</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-jekyllInclude" class="article-heading"><a href="#Optional-jekyllInclude" class="headerlink" title="Optional jekyllInclude"></a><code>Optional</code> jekyllInclude<a class="article-anchor" href="#Optional-jekyllInclude" aria-hidden="true"></a></h3><p>• <strong>jekyllInclude</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L29">src/liquid-options.ts:29</a></em></p>
|
||
<p>Use jekyll style include, pass parameters to <code>include</code> variable of current scope. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-jsTruthy" class="article-heading"><a href="#Optional-jsTruthy" class="headerlink" title="Optional jsTruthy"></a><code>Optional</code> jsTruthy<a class="article-anchor" href="#Optional-jsTruthy" aria-hidden="true"></a></h3><p>• <strong>jsTruthy</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L35">src/liquid-options.ts:35</a></em></p>
|
||
<p>Use Javascript Truthiness. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-keepOutputType" class="article-heading"><a href="#Optional-keepOutputType" class="headerlink" title="Optional keepOutputType"></a><code>Optional</code> keepOutputType<a class="article-anchor" href="#Optional-keepOutputType" aria-hidden="true"></a></h3><p>• <strong>keepOutputType</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L73">src/liquid-options.ts:73</a></em></p>
|
||
<p>Whether or not to keep value type when writing the Output, not working for streamed rendering. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-layouts" class="article-heading"><a href="#Optional-layouts" class="headerlink" title="Optional layouts"></a><code>Optional</code> layouts<a class="article-anchor" href="#Optional-layouts" aria-hidden="true"></a></h3><p>• <strong>layouts</strong>? : <em>string | string[]</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L25">src/liquid-options.ts:25</a></em></p>
|
||
<p>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 <code>root</code></p>
|
||
<hr>
|
||
<h3 id="Optional-lenientIf" class="article-heading"><a href="#Optional-lenientIf" class="headerlink" title="Optional lenientIf"></a><code>Optional</code> lenientIf<a class="article-anchor" href="#Optional-lenientIf" aria-hidden="true"></a></h3><p>• <strong>lenientIf</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L45">src/liquid-options.ts:45</a></em></p>
|
||
<p>Modifies the behavior of <code>strictVariables</code>. If set, a single undefined variable will <em>not</em> cause an exception in the context of the <code>if</code>/<code>elsif</code>/<code>unless</code> tag and the <code>default</code> filter. Instead, it will evaluate to <code>false</code> and <code>null</code>, respectively. Irrelevant if <code>strictVariables</code> is not set. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-operators" class="article-heading"><a href="#Optional-operators" class="headerlink" title="Optional operators"></a><code>Optional</code> operators<a class="article-anchor" href="#Optional-operators" aria-hidden="true"></a></h3><p>• <strong>operators</strong>? : <em><a href="render_operator_.operators.html">Operators</a></em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L77">src/liquid-options.ts:77</a></em></p>
|
||
<p>An object of operators for conditional statements. Defaults to the regular Liquid operators.</p>
|
||
<hr>
|
||
<h3 id="Optional-orderedFilterParameters" class="article-heading"><a href="#Optional-orderedFilterParameters" class="headerlink" title="Optional orderedFilterParameters"></a><code>Optional</code> orderedFilterParameters<a class="article-anchor" href="#Optional-orderedFilterParameters" aria-hidden="true"></a></h3><p>• <strong>orderedFilterParameters</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L79">src/liquid-options.ts:79</a></em></p>
|
||
<p>Respect parameter order when using filters like “for … reversed limit”, Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-outputDelimiterLeft" class="article-heading"><a href="#Optional-outputDelimiterLeft" class="headerlink" title="Optional outputDelimiterLeft"></a><code>Optional</code> outputDelimiterLeft<a class="article-anchor" href="#Optional-outputDelimiterLeft" aria-hidden="true"></a></h3><p>• <strong>outputDelimiterLeft</strong>? : <em>undefined | string</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L61">src/liquid-options.ts:61</a></em></p>
|
||
<p>The left delimiter for liquid outputs.</p>
|
||
<hr>
|
||
<h3 id="Optional-outputDelimiterRight" class="article-heading"><a href="#Optional-outputDelimiterRight" class="headerlink" title="Optional outputDelimiterRight"></a><code>Optional</code> outputDelimiterRight<a class="article-anchor" href="#Optional-outputDelimiterRight" aria-hidden="true"></a></h3><p>• <strong>outputDelimiterRight</strong>? : <em>undefined | string</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L63">src/liquid-options.ts:63</a></em></p>
|
||
<p>The right delimiter for liquid outputs.</p>
|
||
<hr>
|
||
<h3 id="Optional-outputEscape" class="article-heading"><a href="#Optional-outputEscape" class="headerlink" title="Optional outputEscape"></a><code>Optional</code> outputEscape<a class="article-anchor" href="#Optional-outputEscape" aria-hidden="true"></a></h3><p>• <strong>outputEscape</strong>? : <em><a href="../modules/liquid_options_.html#outputescapeoption">OutputEscapeOption</a></em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L75">src/liquid-options.ts:75</a></em></p>
|
||
<p>Default escape filter applied to output values, when set, you’ll have to add <code>| raw</code> for values don’t need to be escaped. Defaults to <code>undefined</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-ownPropertyOnly" class="article-heading"><a href="#Optional-ownPropertyOnly" class="headerlink" title="Optional ownPropertyOnly"></a><code>Optional</code> ownPropertyOnly<a class="article-anchor" href="#Optional-ownPropertyOnly" aria-hidden="true"></a></h3><p>• <strong>ownPropertyOnly</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L43">src/liquid-options.ts:43</a></em></p>
|
||
<p>Hide scope variables from prototypes, useful when you’re passing a not sanitized object into LiquidJS or need to hide prototypes from templates.</p>
|
||
<hr>
|
||
<h3 id="Optional-partials" class="article-heading"><a href="#Optional-partials" class="headerlink" title="Optional partials"></a><code>Optional</code> partials<a class="article-anchor" href="#Optional-partials" aria-hidden="true"></a></h3><p>• <strong>partials</strong>? : <em>string | string[]</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L23">src/liquid-options.ts:23</a></em></p>
|
||
<p>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 <code>root</code></p>
|
||
<hr>
|
||
<h3 id="Optional-preserveTimezones" class="article-heading"><a href="#Optional-preserveTimezones" class="headerlink" title="Optional preserveTimezones"></a><code>Optional</code> preserveTimezones<a class="article-anchor" href="#Optional-preserveTimezones" aria-hidden="true"></a></h3><p>• <strong>preserveTimezones</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L65">src/liquid-options.ts:65</a></em></p>
|
||
<p>Whether input strings to date filter preserve the given timezone</p>
|
||
<hr>
|
||
<h3 id="Optional-relativeReference" class="article-heading"><a href="#Optional-relativeReference" class="headerlink" title="Optional relativeReference"></a><code>Optional</code> relativeReference<a class="article-anchor" href="#Optional-relativeReference" aria-hidden="true"></a></h3><p>• <strong>relativeReference</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L27">src/liquid-options.ts:27</a></em></p>
|
||
<p>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 <code>true</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-root" class="article-heading"><a href="#Optional-root" class="headerlink" title="Optional root"></a><code>Optional</code> root<a class="article-anchor" href="#Optional-root" aria-hidden="true"></a></h3><p>• <strong>root</strong>? : <em>string | string[]</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L21">src/liquid-options.ts:21</a></em></p>
|
||
<p>A directory or an array of directories from where to resolve layout and include templates, and the filename passed to <code>.renderFile()</code>. If it’s an array, the files are looked up in the order they occur in the array. Defaults to <code>["."]</code></p>
|
||
<hr>
|
||
<h3 id="Optional-strictFilters" class="article-heading"><a href="#Optional-strictFilters" class="headerlink" title="Optional strictFilters"></a><code>Optional</code> strictFilters<a class="article-anchor" href="#Optional-strictFilters" aria-hidden="true"></a></h3><p>• <strong>strictFilters</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L39">src/liquid-options.ts:39</a></em></p>
|
||
<p>Whether or not to assert filter existence. If set to <code>false</code>, undefined filters will be skipped. Otherwise, undefined filters will cause an exception. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-strictVariables" class="article-heading"><a href="#Optional-strictVariables" class="headerlink" title="Optional strictVariables"></a><code>Optional</code> strictVariables<a class="article-anchor" href="#Optional-strictVariables" aria-hidden="true"></a></h3><p>• <strong>strictVariables</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L41">src/liquid-options.ts:41</a></em></p>
|
||
<p>Whether or not to assert variable existence. If set to <code>false</code>, undefined variables will be rendered as empty string. Otherwise, undefined variables will cause an exception. Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-tagDelimiterLeft" class="article-heading"><a href="#Optional-tagDelimiterLeft" class="headerlink" title="Optional tagDelimiterLeft"></a><code>Optional</code> tagDelimiterLeft<a class="article-anchor" href="#Optional-tagDelimiterLeft" aria-hidden="true"></a></h3><p>• <strong>tagDelimiterLeft</strong>? : <em>undefined | string</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L57">src/liquid-options.ts:57</a></em></p>
|
||
<p>The left delimiter for liquid tags.</p>
|
||
<hr>
|
||
<h3 id="Optional-tagDelimiterRight" class="article-heading"><a href="#Optional-tagDelimiterRight" class="headerlink" title="Optional tagDelimiterRight"></a><code>Optional</code> tagDelimiterRight<a class="article-anchor" href="#Optional-tagDelimiterRight" aria-hidden="true"></a></h3><p>• <strong>tagDelimiterRight</strong>? : <em>undefined | string</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L59">src/liquid-options.ts:59</a></em></p>
|
||
<p>The right delimiter for liquid tags.</p>
|
||
<hr>
|
||
<h3 id="Optional-timezoneOffset" class="article-heading"><a href="#Optional-timezoneOffset" class="headerlink" title="Optional timezoneOffset"></a><code>Optional</code> timezoneOffset<a class="article-anchor" href="#Optional-timezoneOffset" aria-hidden="true"></a></h3><p>• <strong>timezoneOffset</strong>? : <em>undefined | number</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L47">src/liquid-options.ts:47</a></em></p>
|
||
<p>JavaScript timezoneOffset for <code>date</code> filter, default to local time. That means if you’re in Australia (UTC+10), it’ll default to -600</p>
|
||
<hr>
|
||
<h3 id="Optional-trimOutputLeft" class="article-heading"><a href="#Optional-trimOutputLeft" class="headerlink" title="Optional trimOutputLeft"></a><code>Optional</code> trimOutputLeft<a class="article-anchor" href="#Optional-trimOutputLeft" aria-hidden="true"></a></h3><p>• <strong>trimOutputLeft</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L55">src/liquid-options.ts:55</a></em></p>
|
||
<p>Similar to <code>trimOutputRight</code>, whereas the <code>\n</code> is exclusive. Defaults to <code>false</code>. See Whitespace Control for details.</p>
|
||
<hr>
|
||
<h3 id="Optional-trimOutputRight" class="article-heading"><a href="#Optional-trimOutputRight" class="headerlink" title="Optional trimOutputRight"></a><code>Optional</code> trimOutputRight<a class="article-anchor" href="#Optional-trimOutputRight" aria-hidden="true"></a></h3><p>• <strong>trimOutputRight</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L53">src/liquid-options.ts:53</a></em></p>
|
||
<p>Strip blank characters (including <code></code>, <code>\t</code>, and <code>\r</code>) from the right of values (<code>{{ }}</code>) until <code>\n</code> (inclusive). Defaults to <code>false</code>.</p>
|
||
<hr>
|
||
<h3 id="Optional-trimTagLeft" class="article-heading"><a href="#Optional-trimTagLeft" class="headerlink" title="Optional trimTagLeft"></a><code>Optional</code> trimTagLeft<a class="article-anchor" href="#Optional-trimTagLeft" aria-hidden="true"></a></h3><p>• <strong>trimTagLeft</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L51">src/liquid-options.ts:51</a></em></p>
|
||
<p>Similar to <code>trimTagRight</code>, whereas the <code>\n</code> is exclusive. Defaults to <code>false</code>. See Whitespace Control for details.</p>
|
||
<hr>
|
||
<h3 id="Optional-trimTagRight" class="article-heading"><a href="#Optional-trimTagRight" class="headerlink" title="Optional trimTagRight"></a><code>Optional</code> trimTagRight<a class="article-anchor" href="#Optional-trimTagRight" aria-hidden="true"></a></h3><p>• <strong>trimTagRight</strong>? : <em>undefined | false | true</em></p>
|
||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L49">src/liquid-options.ts:49</a></em></p>
|
||
<p>Strip blank characters (including <code></code>, <code>\t</code>, and <code>\r</code>) from the right of tags (<code>{% %}</code>) until <code>\n</code> (inclusive). Defaults to <code>false</code>.</p>
|
||
|
||
</div>
|
||
<footer class="article-footer">
|
||
<time class="article-footer-updated" datetime="2022-11-14T09:25:44.768Z" itemprop="dateModified">Last updated: 2022-11-14</time>
|
||
<a href="../classes/liquid_.liquid.html" class="article-footer-next" title="sidebar.api.Liquid"><span>Next</span><i class="icon-chevron-right"></i></a>
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
<aside id="article-toc" role="navigation">
|
||
<div id="article-toc-inner">
|
||
<div id="article-toc-inner-list">
|
||
<strong class="sidebar-title">Contents</strong>
|
||
<ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Hierarchy"><span class="toc-text">Hierarchy</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Properties"><span class="toc-text">Properties</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-cache"><span class="toc-text">Optional cache</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-dynamicPartials"><span class="toc-text">Optional dynamicPartials</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-extname"><span class="toc-text">Optional extname</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-fs"><span class="toc-text">Optional fs</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-globals"><span class="toc-text">Optional globals</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-greedy"><span class="toc-text">Optional greedy</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-jekyllInclude"><span class="toc-text">Optional jekyllInclude</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-jsTruthy"><span class="toc-text">Optional jsTruthy</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-keepOutputType"><span class="toc-text">Optional keepOutputType</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-layouts"><span class="toc-text">Optional layouts</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-lenientIf"><span class="toc-text">Optional lenientIf</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-operators"><span class="toc-text">Optional operators</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-orderedFilterParameters"><span class="toc-text">Optional orderedFilterParameters</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-outputDelimiterLeft"><span class="toc-text">Optional outputDelimiterLeft</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-outputDelimiterRight"><span class="toc-text">Optional outputDelimiterRight</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-outputEscape"><span class="toc-text">Optional outputEscape</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-ownPropertyOnly"><span class="toc-text">Optional ownPropertyOnly</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-partials"><span class="toc-text">Optional partials</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-preserveTimezones"><span class="toc-text">Optional preserveTimezones</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-relativeReference"><span class="toc-text">Optional relativeReference</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-root"><span class="toc-text">Optional root</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-strictFilters"><span class="toc-text">Optional strictFilters</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-strictVariables"><span class="toc-text">Optional strictVariables</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-tagDelimiterLeft"><span class="toc-text">Optional tagDelimiterLeft</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-tagDelimiterRight"><span class="toc-text">Optional tagDelimiterRight</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-timezoneOffset"><span class="toc-text">Optional timezoneOffset</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-trimOutputLeft"><span class="toc-text">Optional trimOutputLeft</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-trimOutputRight"><span class="toc-text">Optional trimOutputRight</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-trimTagLeft"><span class="toc-text">Optional trimTagLeft</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Optional-trimTagRight"><span class="toc-text">Optional trimTagRight</span></a></li></ol></li></ol>
|
||
</div>
|
||
<a href="#" id="article-toc-top">Back to Top</a>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer id="footer" class="wrapper">
|
||
<div class="inner">
|
||
<div id="footer-copyright">
|
||
© 2022 <a href="https://github.com/harttle/liquidjs/graphs/contributors" rel="external nofollow noreferrer" target="_blank">Harttle</a><br>
|
||
Documentation licensed under <a href="http://creativecommons.org/licenses/by/4.0/" rel="external nofollow noreferrer" target="_blank">CC BY 4.0</a>.
|
||
</div>
|
||
<div id="footer-links">
|
||
<a href="https://twitter.com/harttleharttle" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-twitter"></i></a>
|
||
<a href="https://www.patreon.com/harttle" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-patreon"></i></a>
|
||
<a href="https://opencollective.com/liquidjs" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-opencollective"></i></a>
|
||
<a href="https://github.com/harttle/liquidjs" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="icon-github"></i></a>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div id="mobile-nav-dimmer"></div>
|
||
<nav id="mobile-nav">
|
||
<div id="mobile-nav-inner">
|
||
<ul id="mobile-nav-list">
|
||
<a href="../../tutorials/intro-to-liquid.html" class="mobile-nav-link">Tutorials</a><a href="../../tags/overview.html" class="mobile-nav-link">Tags</a><a href="../../filters/overview.html" class="mobile-nav-link">Filters</a><a href="../../playground.html" class="mobile-nav-link">Playground</a><a href="../../api/classes/liquid_.liquid.html" class="mobile-nav-link">API</a>
|
||
</ul>
|
||
|
||
<div class="mobile-sidebar-list">
|
||
<strong class="mobile-nav-title">Quick Entry</strong><a href="../classes/liquid_.liquid.html" class="mobile-nav-link">Liquid</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="mobile-nav-link">LiquidOptions</a><a href="../interfaces/fs_fs_.fs.html" class="mobile-nav-link">FS</a><a href="../interfaces/cache_cache_.cache.html" class="mobile-nav-link">Cache</a><strong class="mobile-nav-title">Classes</strong><a href="../classes/drop_blank_drop_.blankdrop.html" class="mobile-nav-link">BlankDrop</a><a href="../classes/context_context_.context.html" class="mobile-nav-link">Context</a><a href="../classes/tokens_delimited_token_.delimitedtoken.html" class="mobile-nav-link">DelimitedToken</a><a href="../classes/drop_drop_.drop.html" class="mobile-nav-link">Drop</a><a href="../classes/drop_empty_drop_.emptydrop.html" class="mobile-nav-link">EmptyDrop</a><a href="../classes/render_expression_.expression.html" class="mobile-nav-link">Expression</a><a href="../classes/tokens_filter_token_.filtertoken.html" class="mobile-nav-link">FilterToken</a><a href="../classes/drop_forloop_drop_.forloopdrop.html" class="mobile-nav-link">ForloopDrop</a><a href="../classes/tokens_html_token_.htmltoken.html" class="mobile-nav-link">HTMLToken</a><a href="../classes/tokens_hash_token_.hashtoken.html" class="mobile-nav-link">HashToken</a><a href="../classes/cache_lru_.lru.html" class="mobile-nav-link">LRU</a><a href="../classes/liquid_.liquid.html" class="mobile-nav-link">Liquid</a><a href="../classes/tokens_literal_token_.literaltoken.html" class="mobile-nav-link">LiteralToken</a><a href="../classes/drop_null_drop_.nulldrop.html" class="mobile-nav-link">NullDrop</a><a href="../classes/tokens_number_token_.numbertoken.html" class="mobile-nav-link">NumberToken</a><a href="../classes/tokens_operator_token_.operatortoken.html" class="mobile-nav-link">OperatorToken</a><a href="../classes/tokens_output_token_.outputtoken.html" class="mobile-nav-link">OutputToken</a><a href="../classes/util_error_.parseerror.html" class="mobile-nav-link">ParseError</a><a href="../classes/parser_parse_stream_.parsestream.html" class="mobile-nav-link">ParseStream</a><a href="../classes/parser_parser_.parser.html" class="mobile-nav-link">Parser</a><a href="../classes/tokens_property_access_token_.propertyaccesstoken.html" class="mobile-nav-link">PropertyaccessToken</a><a href="../classes/tokens_quoted_token_.quotedtoken.html" class="mobile-nav-link">QuotedToken</a><a href="../classes/tokens_range_token_.rangetoken.html" class="mobile-nav-link">RangeToken</a><a href="../classes/render_render_.render.html" class="mobile-nav-link">Render</a><a href="../classes/util_error_.rendererror.html" class="mobile-nav-link">RenderError</a><a href="../classes/drop_tablerowloop_drop_.tablerowloopdrop.html" class="mobile-nav-link">TablerowloopDrop</a><a href="../classes/tokens_tag_token_.tagtoken.html" class="mobile-nav-link">TagToken</a><a href="../classes/tokens_token_.token.html" class="mobile-nav-link">Token</a><a href="../classes/util_error_.tokenizationerror.html" class="mobile-nav-link">TokenizationError</a><a href="../classes/parser_tokenizer_.tokenizer.html" class="mobile-nav-link">Tokenizer</a><a href="../classes/tokens_word_token_.wordtoken.html" class="mobile-nav-link">WordToken</a><strong class="mobile-nav-title">Enums</strong><a href="../enums/context_block_mode_.blockmode.html" class="mobile-nav-link">BlockMode</a><a href="../enums/parser_token_kind_.tokenkind.html" class="mobile-nav-link">TokenKind</a><strong class="mobile-nav-title">Interfaces</strong><a href="../interfaces/cache_cache_.cache.html" class="mobile-nav-link">Cache</a><a href="../interfaces/template_filter_filter_impl_options_.filterimploptions.html" class="mobile-nav-link">FilterImplOptions</a><a href="../interfaces/fs_fs_.fs.html" class="mobile-nav-link">FS</a><a href="../interfaces/liquid_options_.liquidoptions.html" class="mobile-nav-link">LiquidOptions</a><a href="../interfaces/liquid_options_.normalizedfulloptions.html" class="mobile-nav-link">NormalizedFullOptions</a><a href="../interfaces/context_scope_.plainobject.html" class="mobile-nav-link">PlainObject</a><a href="../interfaces/template_tag_tag_impl_options_.tagimploptions.html" class="mobile-nav-link">TagImplOptions</a>
|
||
</div>
|
||
|
||
</div>
|
||
<div id="mobile-button-list">
|
||
<a href="https://github.com/harttle/liquidjs" class="mobile-nav-link" rel="external" target="_blank"><i class="icon-github"></i></a>
|
||
<a href="https://opencollective.com/liquidjs" class="mobile-nav-link" rel="external" target="_blank"><i class="icon-opencollective"></i></a>
|
||
<div id="mobile-lang-select-wrap" class="mobile-nav-link">
|
||
<label for="mobile-lang-select"><i class="icon-network"></i></label>
|
||
<select id="mobile-lang-select" data-canonical="api/interfaces/liquid_options_.liquidoptions.html">
|
||
|
||
<option value="en" selected>English</option>
|
||
|
||
<option value="zh-cn">简体中文</option>
|
||
|
||
</select>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
|
||
<script src="../../js/main.js"></script>
|
||
|
||
|
||
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
||
<script>
|
||
document.getElementById('search-input-wrap').classList.add('on');
|
||
docsearch({
|
||
apiKey: '01f36cc168657a26a385308b9e721bc6',
|
||
indexName: 'liquidjs',
|
||
inputSelector: '#search-input',
|
||
debug: false
|
||
});
|
||
</script>
|
||
</body>
|
||
</html> |