Deploying to gh-pages from @ harttle/liquidjs@7e99efc513 🚀

This commit is contained in:
harttle
2022-01-28 17:27:54 +00:00
parent 59a0c0550f
commit 5b3a84961b
557 changed files with 3820 additions and 3137 deletions
+39 -32
View File
@@ -5,6 +5,7 @@
<title>Module: &quot;liquid-options&quot; | 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 -->
@@ -92,7 +93,7 @@
</header>
<div class="article-content" itemprop="articleBody">
<h2 id="Functions" class="article-heading"><a href="#Functions" class="headerlink" title="Functions"></a>Functions<a class="article-anchor" href="#Functions" aria-hidden="true"></a></h2><h3 id="normalize" class="article-heading"><a href="#normalize" class="headerlink" title="normalize"></a>normalize<a class="article-anchor" href="#normalize" aria-hidden="true"></a></h3><p><strong>normalize</strong>(<code>options</code>: <a href="../interfaces/liquid_options_.liquidoptions.html">LiquidOptions</a>): <em><a href="../interfaces/liquid_options_.normalizedfulloptions.html">NormalizedFullOptions</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#L153">src/liquid-options.ts:153</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#L161">src/liquid-options.ts:161</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -109,7 +110,7 @@
<p><strong>Returns:</strong> <em><a href="../interfaces/liquid_options_.normalizedfulloptions.html">NormalizedFullOptions</a></em></p>
<hr>
<h3 id="normalizeDirectoryList" class="article-heading"><a href="#normalizeDirectoryList" class="headerlink" title="normalizeDirectoryList"></a>normalizeDirectoryList<a class="article-anchor" href="#normalizeDirectoryList" aria-hidden="true"></a></h3><p><strong>normalizeDirectoryList</strong>(<code>value</code>: any): <em>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#L179">src/liquid-options.ts:179</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#L187">src/liquid-options.ts:187</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -124,97 +125,103 @@
</tr>
</tbody></table>
<p><strong>Returns:</strong> <em>string[]</em></p>
<h2 id="Object-literals" class="article-heading"><a href="#Object-literals" class="headerlink" title="Object literals"></a>Object literals<a class="article-anchor" href="#Object-literals" aria-hidden="true"></a></h2><h3 id="Const-defaultOptions" class="article-heading"><a href="#Const-defaultOptions" class="headerlink" title="Const defaultOptions"></a><code>Const</code> defaultOptions<a class="article-anchor" href="#Const-defaultOptions" aria-hidden="true"></a></h3><h3 id="▪-defaultOptions-object" class="article-heading"><a href="#▪-defaultOptions-object" class="headerlink" title="▪ defaultOptions: object"></a><strong>defaultOptions</strong>: <em>object</em><a class="article-anchor" href="#▪-defaultOptions-object" aria-hidden="true"></a></h3><p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L123">src/liquid-options.ts:123</a></em></p>
<h2 id="Object-literals" class="article-heading"><a href="#Object-literals" class="headerlink" title="Object literals"></a>Object literals<a class="article-anchor" href="#Object-literals" aria-hidden="true"></a></h2><h3 id="Const-defaultOptions" class="article-heading"><a href="#Const-defaultOptions" class="headerlink" title="Const defaultOptions"></a><code>Const</code> defaultOptions<a class="article-anchor" href="#Const-defaultOptions" aria-hidden="true"></a></h3><h3 id="▪-defaultOptions-object" class="article-heading"><a href="#▪-defaultOptions-object" class="headerlink" title="▪ defaultOptions: object"></a><strong>defaultOptions</strong>: <em>object</em><a class="article-anchor" href="#▪-defaultOptions-object" aria-hidden="true"></a></h3><p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L130">src/liquid-options.ts:130</a></em></p>
<h3 id="cache" class="article-heading"><a href="#cache" class="headerlink" title="cache"></a>cache<a class="article-anchor" href="#cache" aria-hidden="true"></a></h3><p><strong>cache</strong>: <em>undefined</em> = undefined</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#L129">src/liquid-options.ts:129</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#L136">src/liquid-options.ts:136</a></em></p>
<h3 id="dynamicPartials" class="article-heading"><a href="#dynamicPartials" class="headerlink" title="dynamicPartials"></a>dynamicPartials<a class="article-anchor" href="#dynamicPartials" aria-hidden="true"></a></h3><p><strong>dynamicPartials</strong>: <em>true</em> = true</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#L132">src/liquid-options.ts:132</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#L139">src/liquid-options.ts:139</a></em></p>
<h3 id="extname" class="article-heading"><a href="#extname" class="headerlink" title="extname"></a>extname<a class="article-anchor" href="#extname" aria-hidden="true"></a></h3><p><strong>extname</strong>: <em>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#L130">src/liquid-options.ts:130</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#L137">src/liquid-options.ts:137</a></em></p>
<h3 id="fs" class="article-heading"><a href="#fs" class="headerlink" title="fs"></a>fs<a class="article-anchor" href="#fs" aria-hidden="true"></a></h3><p><strong>fs</strong>: <em><a href="fs_node_.html">“fs/node”</a></em> = fs</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#L131">src/liquid-options.ts:131</a></em></p>
<h3 id="globals" class="article-heading"><a href="#globals" class="headerlink" title="globals"></a>globals<a class="article-anchor" href="#globals" aria-hidden="true"></a></h3><p><strong>globals</strong>: <em>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#L147">src/liquid-options.ts:147</a></em></p>
<h4 id="Type-declaration" class="article-heading"><a href="#Type-declaration" class="headerlink" title="Type declaration:"></a>Type declaration:<a class="article-anchor" href="#Type-declaration" aria-hidden="true"></a></h4><h3 id="greedy" class="article-heading"><a href="#greedy" class="headerlink" title="greedy"></a>greedy<a class="article-anchor" href="#greedy" aria-hidden="true"></a></h3><p><strong>greedy</strong>: <em>true</em> = true</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#L138">src/liquid-options.ts:138</a></em></p>
<h3 id="globals" class="article-heading"><a href="#globals" class="headerlink" title="globals"></a>globals<a class="article-anchor" href="#globals" aria-hidden="true"></a></h3><p><strong>globals</strong>: <em>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#L155">src/liquid-options.ts:155</a></em></p>
<h4 id="Type-declaration" class="article-heading"><a href="#Type-declaration" class="headerlink" title="Type declaration:"></a>Type declaration:<a class="article-anchor" href="#Type-declaration" aria-hidden="true"></a></h4><h3 id="greedy" class="article-heading"><a href="#greedy" class="headerlink" title="greedy"></a>greedy<a class="article-anchor" href="#greedy" aria-hidden="true"></a></h3><p><strong>greedy</strong>: <em>true</em> = true</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#L145">src/liquid-options.ts:145</a></em></p>
<h3 id="jekyllInclude" class="article-heading"><a href="#jekyllInclude" class="headerlink" title="jekyllInclude"></a>jekyllInclude<a class="article-anchor" href="#jekyllInclude" aria-hidden="true"></a></h3><p><strong>jekyllInclude</strong>: <em>false</em> = false</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#L128">src/liquid-options.ts:128</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#L135">src/liquid-options.ts:135</a></em></p>
<h3 id="jsTruthy" class="article-heading"><a href="#jsTruthy" class="headerlink" title="jsTruthy"></a>jsTruthy<a class="article-anchor" href="#jsTruthy" aria-hidden="true"></a></h3><p><strong>jsTruthy</strong>: <em>false</em> = false</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#L133">src/liquid-options.ts:133</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#L140">src/liquid-options.ts:140</a></em></p>
<h3 id="keepOutputType" class="article-heading"><a href="#keepOutputType" class="headerlink" title="keepOutputType"></a>keepOutputType<a class="article-anchor" href="#keepOutputType" aria-hidden="true"></a></h3><p><strong>keepOutputType</strong>: <em>false</em> = false</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#L148">src/liquid-options.ts:148</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#L156">src/liquid-options.ts:156</a></em></p>
<h3 id="layouts" class="article-heading"><a href="#layouts" class="headerlink" title="layouts"></a>layouts<a class="article-anchor" href="#layouts" aria-hidden="true"></a></h3><p><strong>layouts</strong>: <em>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#L125">src/liquid-options.ts:125</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#L132">src/liquid-options.ts:132</a></em></p>
<h3 id="lenientIf" class="article-heading"><a href="#lenientIf" class="headerlink" title="lenientIf"></a>lenientIf<a class="article-anchor" href="#lenientIf" aria-hidden="true"></a></h3><p><strong>lenientIf</strong>: <em>false</em> = false</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#L146">src/liquid-options.ts:146</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#L154">src/liquid-options.ts:154</a></em></p>
<h3 id="operators" class="article-heading"><a href="#operators" class="headerlink" title="operators"></a>operators<a class="article-anchor" href="#operators" aria-hidden="true"></a></h3><p><strong>operators</strong>: <em><a href="../interfaces/render_operator_.operators.html">Operators</a></em> = defaultOperators</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#L149">src/liquid-options.ts:149</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#L157">src/liquid-options.ts:157</a></em></p>
<h3 id="operatorsTrie" class="article-heading"><a href="#operatorsTrie" class="headerlink" title="operatorsTrie"></a>operatorsTrie<a class="article-anchor" href="#operatorsTrie" aria-hidden="true"></a></h3><p><strong>operatorsTrie</strong>: <em><a href="../interfaces/util_operator_trie_.trie.html">Trie</a></em> = createTrie(defaultOperators)</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#L150">src/liquid-options.ts:150</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#L158">src/liquid-options.ts:158</a></em></p>
<h3 id="outputDelimiterLeft" class="article-heading"><a href="#outputDelimiterLeft" class="headerlink" title="outputDelimiterLeft"></a>outputDelimiterLeft<a class="article-anchor" href="#outputDelimiterLeft" aria-hidden="true"></a></h3><p><strong>outputDelimiterLeft</strong>: <em>string</em> = “{{"
*Defined in [src/liquid-options.ts:141](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L141)*
*Defined in [src/liquid-options.ts:148](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L148)*
### outputDelimiterRight
• **outputDelimiterRight**: *string* = "}}"
*Defined in [src/liquid-options.ts:142](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L142)*
*Defined in [src/liquid-options.ts:149](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L149)*
### ownPropertyOnly
• **ownPropertyOnly**: *false* = false
*Defined in [src/liquid-options.ts:153](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L153)*
### partials
• **partials**: *string[]* = ['.']
*Defined in [src/liquid-options.ts:126](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L126)*
*Defined in [src/liquid-options.ts:133](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L133)*
### preserveTimezones
• **preserveTimezones**: *false* = false
*Defined in [src/liquid-options.ts:143](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L143)*
*Defined in [src/liquid-options.ts:150](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L150)*
### relativeReference
• **relativeReference**: *true* = true
*Defined in [src/liquid-options.ts:127](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L127)*
*Defined in [src/liquid-options.ts:134](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L134)*
### root
• **root**: *string[]* = ['.']
*Defined in [src/liquid-options.ts:124](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L124)*
*Defined in [src/liquid-options.ts:131](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L131)*
### strictFilters
• **strictFilters**: *false* = false
*Defined in [src/liquid-options.ts:144](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L144)*
*Defined in [src/liquid-options.ts:151](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L151)*
### strictVariables
• **strictVariables**: *false* = false
*Defined in [src/liquid-options.ts:145](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L145)*
*Defined in [src/liquid-options.ts:152](https://github.com/harttle/liquidjs/blob/master/src/liquid-options.ts#L152)*
### tagDelimiterLeft
• **tagDelimiterLeft**: *string* = "{%“</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#L139">src/liquid-options.ts:139</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#L146">src/liquid-options.ts:146</a></em></p>
<h3 id="tagDelimiterRight" class="article-heading"><a href="#tagDelimiterRight" class="headerlink" title="tagDelimiterRight"></a>tagDelimiterRight<a class="article-anchor" href="#tagDelimiterRight" aria-hidden="true"></a></h3><p><strong>tagDelimiterRight</strong>: <em>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#L140">src/liquid-options.ts:140</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#L147">src/liquid-options.ts:147</a></em></p>
<h3 id="trimOutputLeft" class="article-heading"><a href="#trimOutputLeft" class="headerlink" title="trimOutputLeft"></a>trimOutputLeft<a class="article-anchor" href="#trimOutputLeft" aria-hidden="true"></a></h3><p><strong>trimOutputLeft</strong>: <em>false</em> = false</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#L137">src/liquid-options.ts:137</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#L144">src/liquid-options.ts:144</a></em></p>
<h3 id="trimOutputRight" class="article-heading"><a href="#trimOutputRight" class="headerlink" title="trimOutputRight"></a>trimOutputRight<a class="article-anchor" href="#trimOutputRight" aria-hidden="true"></a></h3><p><strong>trimOutputRight</strong>: <em>false</em> = false</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#L136">src/liquid-options.ts:136</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#L143">src/liquid-options.ts:143</a></em></p>
<h3 id="trimTagLeft" class="article-heading"><a href="#trimTagLeft" class="headerlink" title="trimTagLeft"></a>trimTagLeft<a class="article-anchor" href="#trimTagLeft" aria-hidden="true"></a></h3><p><strong>trimTagLeft</strong>: <em>false</em> = false</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#L135">src/liquid-options.ts:135</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#L142">src/liquid-options.ts:142</a></em></p>
<h3 id="trimTagRight" class="article-heading"><a href="#trimTagRight" class="headerlink" title="trimTagRight"></a>trimTagRight<a class="article-anchor" href="#trimTagRight" aria-hidden="true"></a></h3><p><strong>trimTagRight</strong>: <em>false</em> = false</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#L134">src/liquid-options.ts:134</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#L141">src/liquid-options.ts:141</a></em></p>
</div>
<footer class="article-footer">
<time class="article-footer-updated" datetime="2022-01-28T14:44:29.267Z" itemprop="dateModified">Last updated: 2022-01-28</time>
<time class="article-footer-updated" datetime="2022-01-28T17:27:39.905Z" itemprop="dateModified">Last updated: 2022-01-28</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>