mirror of
https://github.com/harttle/liquidjs.git
synced 2026-09-17 21:40:39 -07:00
Deploying to gh-pages from @ harttle/liquidjs@1380ac931a 🚀
This commit is contained in:
harttle
@@ -97,7 +97,7 @@
|
||||
<li><strong>Context</strong></li>
|
||||
</ul>
|
||||
<h2 id="Constructors" class="article-heading"><a href="#Constructors" class="headerlink" title="Constructors"></a>Constructors<a class="article-anchor" href="#Constructors" aria-hidden="true"></a></h2><h3 id="constructor-NaN" class="article-heading"><a href="#constructor-NaN" class="headerlink" title="constructor"></a>constructor<a class="article-anchor" href="#constructor-NaN" aria-hidden="true"></a></h3><p>+ <strong>new Context</strong>(<code>env</code>: object, <code>opts</code>: <a href="../interfaces/liquid_options_.normalizedfulloptions.html">NormalizedFullOptions</a>, <code>renderOptions</code>: <a href="../interfaces/liquid_options_.renderoptions.html">RenderOptions</a>): <em><a href="context_context_.context.html">Context</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L36">src/context/context.ts:36</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L34">src/context/context.ts:34</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -125,32 +125,32 @@
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em><a href="context_context_.context.html">Context</a></em></p>
|
||||
<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="environments" class="article-heading"><a href="#environments" class="headerlink" title="environments"></a>environments<a class="article-anchor" href="#environments" aria-hidden="true"></a></h3><p>• <strong>environments</strong>: <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L23">src/context/context.ts:23</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L21">src/context/context.ts:21</a></em></p>
|
||||
<p>user passed in scope<br><code>{% increment %}</code>, <code>{% decrement %}</code> changes this scope,<br>whereas <code>{% capture %}</code>, <code>{% assign %}</code> only hide this scope</p>
|
||||
<hr>
|
||||
<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><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L27">src/context/context.ts:27</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L25">src/context/context.ts:25</a></em></p>
|
||||
<p>global scope used as fallback for missing variables</p>
|
||||
<hr>
|
||||
<h3 id="opts" class="article-heading"><a href="#opts" class="headerlink" title="opts"></a>opts<a class="article-anchor" href="#opts" aria-hidden="true"></a></h3><p>• <strong>opts</strong>: <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/context/context.ts#L32">src/context/context.ts:32</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L30">src/context/context.ts:30</a></em></p>
|
||||
<p>The normalized liquid options object</p>
|
||||
<hr>
|
||||
<h3 id="Private-registers" class="article-heading"><a href="#Private-registers" class="headerlink" title="Private registers"></a><code>Private</code> registers<a class="article-anchor" href="#Private-registers" aria-hidden="true"></a></h3><p>• <strong>registers</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/context/context.ts#L17">src/context/context.ts:17</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L15">src/context/context.ts:15</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><hr>
|
||||
<h3 id="Private-scopes" class="article-heading"><a href="#Private-scopes" class="headerlink" title="Private scopes"></a><code>Private</code> scopes<a class="article-anchor" href="#Private-scopes" aria-hidden="true"></a></h3><p>• <strong>scopes</strong>: <em><a href="../modules/context_scope_.html#scope">Scope</a>[]</em> = [{}]</p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L16">src/context/context.ts:16</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L14">src/context/context.ts:14</a></em></p>
|
||||
<p>insert a Context-level empty scope,<br>for tags like <code>{% capture %}</code> <code>{% assign %}</code> to operate</p>
|
||||
<hr>
|
||||
<h3 id="strictVariables" class="article-heading"><a href="#strictVariables" class="headerlink" title="strictVariables"></a>strictVariables<a class="article-anchor" href="#strictVariables" aria-hidden="true"></a></h3><p>• <strong>strictVariables</strong>: <em>boolean</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L36">src/context/context.ts:36</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L34">src/context/context.ts:34</a></em></p>
|
||||
<p>Throw when accessing undefined variable?</p>
|
||||
<hr>
|
||||
<h3 id="sync" class="article-heading"><a href="#sync" class="headerlink" title="sync"></a>sync<a class="article-anchor" href="#sync" aria-hidden="true"></a></h3><p>• <strong>sync</strong>: <em>boolean</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L28">src/context/context.ts:28</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L26">src/context/context.ts:26</a></em></p>
|
||||
<h2 id="Methods" class="article-heading"><a href="#Methods" class="headerlink" title="Methods"></a>Methods<a class="article-anchor" href="#Methods" aria-hidden="true"></a></h2><h3 id="get" class="article-heading"><a href="#get" class="headerlink" title="_get"></a>_get<a class="article-anchor" href="#get" aria-hidden="true"></a></h3><p>▸ <strong>_get</strong>(<code>paths</code>: <a href="../modules/context_context_.html#propertykey">PropertyKey</a>[]): <em>IterableIterator‹unknown›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L66">src/context/context.ts:66</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L64">src/context/context.ts:64</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -167,7 +167,7 @@
|
||||
<p><strong>Returns:</strong> <em>IterableIterator‹unknown›</em></p>
|
||||
<hr>
|
||||
<h3 id="getFromScope" class="article-heading"><a href="#getFromScope" class="headerlink" title="_getFromScope"></a>_getFromScope<a class="article-anchor" href="#getFromScope" aria-hidden="true"></a></h3><p>▸ <strong>_getFromScope</strong>(<code>scope</code>: unknown, <code>paths</code>: <a href="../modules/context_context_.html#propertykey">PropertyKey</a>[] | string): <em>IterableIterator‹unknown›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L76">src/context/context.ts:76</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L74">src/context/context.ts:74</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -188,11 +188,11 @@
|
||||
<p><strong>Returns:</strong> <em>IterableIterator‹unknown›</em></p>
|
||||
<hr>
|
||||
<h3 id="bottom" class="article-heading"><a href="#bottom" class="headerlink" title="bottom"></a>bottom<a class="article-anchor" href="#bottom" aria-hidden="true"></a></h3><p>▸ <strong>bottom</strong>(): <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L92">src/context/context.ts:92</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L90">src/context/context.ts:90</a></em></p>
|
||||
<p><strong>Returns:</strong> <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<hr>
|
||||
<h3 id="Private-findScope" class="article-heading"><a href="#Private-findScope" class="headerlink" title="Private findScope"></a><code>Private</code> findScope<a class="article-anchor" href="#Private-findScope" aria-hidden="true"></a></h3><p>▸ <strong>findScope</strong>(<code>key</code>: string | number): <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L95">src/context/context.ts:95</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L93">src/context/context.ts:93</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -209,7 +209,7 @@
|
||||
<p><strong>Returns:</strong> <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<hr>
|
||||
<h3 id="get-1" class="article-heading"><a href="#get-1" class="headerlink" title="get"></a>get<a class="article-anchor" href="#get-1" aria-hidden="true"></a></h3><p>▸ <strong>get</strong>(<code>paths</code>: <a href="../modules/context_context_.html#propertykey">PropertyKey</a>[]): <em>unknown</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L63">src/context/context.ts:63</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L61">src/context/context.ts:61</a></em></p>
|
||||
<p><strong><code>deprecated</code></strong> use <code>_get()</code> instead</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -227,11 +227,11 @@
|
||||
<p><strong>Returns:</strong> <em>unknown</em></p>
|
||||
<hr>
|
||||
<h3 id="getAll" class="article-heading"><a href="#getAll" class="headerlink" title="getAll"></a>getAll<a class="article-anchor" href="#getAll" aria-hidden="true"></a></h3><p>▸ <strong>getAll</strong>(): <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L56">src/context/context.ts:56</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L54">src/context/context.ts:54</a></em></p>
|
||||
<p><strong>Returns:</strong> <em><a href="../modules/context_scope_.html#scope">Scope</a></em></p>
|
||||
<hr>
|
||||
<h3 id="getFromScope-1" class="article-heading"><a href="#getFromScope-1" class="headerlink" title="getFromScope"></a>getFromScope<a class="article-anchor" href="#getFromScope-1" aria-hidden="true"></a></h3><p>▸ <strong>getFromScope</strong>(<code>scope</code>: unknown, <code>paths</code>: <a href="../modules/context_context_.html#propertykey">PropertyKey</a>[] | string): <em>IterableIterator‹unknown›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L73">src/context/context.ts:73</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L71">src/context/context.ts:71</a></em></p>
|
||||
<p><strong><code>deprecated</code></strong> use <code>_get()</code> instead</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -253,7 +253,7 @@
|
||||
<p><strong>Returns:</strong> <em>IterableIterator‹unknown›</em></p>
|
||||
<hr>
|
||||
<h3 id="getRegister" class="article-heading"><a href="#getRegister" class="headerlink" title="getRegister"></a>getRegister<a class="article-anchor" href="#getRegister" aria-hidden="true"></a></h3><p>▸ <strong>getRegister</strong>(<code>key</code>: string): <em>any</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L44">src/context/context.ts:44</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L42">src/context/context.ts:42</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -269,12 +269,12 @@
|
||||
</tbody></table>
|
||||
<p><strong>Returns:</strong> <em>any</em></p>
|
||||
<hr>
|
||||
<h3 id="pop" class="article-heading"><a href="#pop" class="headerlink" title="pop"></a>pop<a class="article-anchor" href="#pop" aria-hidden="true"></a></h3><p>▸ <strong>pop</strong>(): <em>undefined | <a href="drop_drop_.drop.html">Drop</a>‹› | <a href="../interfaces/context_scope_.plainobject.html">PlainObject</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L89">src/context/context.ts:89</a></em></p>
|
||||
<p><strong>Returns:</strong> <em>undefined | <a href="drop_drop_.drop.html">Drop</a>‹› | <a href="../interfaces/context_scope_.plainobject.html">PlainObject</a></em></p>
|
||||
<h3 id="pop" class="article-heading"><a href="#pop" class="headerlink" title="pop"></a>pop<a class="article-anchor" href="#pop" aria-hidden="true"></a></h3><p>▸ <strong>pop</strong>(): <em>undefined | <a href="../interfaces/context_scope_.scopeobject.html">ScopeObject</a>‹› | <a href="drop_drop_.drop.html">Drop</a>‹›</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L87">src/context/context.ts:87</a></em></p>
|
||||
<p><strong>Returns:</strong> <em>undefined | <a href="../interfaces/context_scope_.scopeobject.html">ScopeObject</a>‹› | <a href="drop_drop_.drop.html">Drop</a>‹›</em></p>
|
||||
<hr>
|
||||
<h3 id="push" class="article-heading"><a href="#push" class="headerlink" title="push"></a>push<a class="article-anchor" href="#push" aria-hidden="true"></a></h3><p>▸ <strong>push</strong>(<code>ctx</code>: object): <em>number</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L86">src/context/context.ts:86</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L84">src/context/context.ts:84</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -291,7 +291,7 @@
|
||||
<p><strong>Returns:</strong> <em>number</em></p>
|
||||
<hr>
|
||||
<h3 id="restoreRegister" class="article-heading"><a href="#restoreRegister" class="headerlink" title="restoreRegister"></a>restoreRegister<a class="article-anchor" href="#restoreRegister" aria-hidden="true"></a></h3><p>▸ <strong>restoreRegister</strong>(<code>keyValues</code>: [string, any][]): <em>void</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L53">src/context/context.ts:53</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L51">src/context/context.ts:51</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -308,7 +308,7 @@
|
||||
<p><strong>Returns:</strong> <em>void</em></p>
|
||||
<hr>
|
||||
<h3 id="saveRegister" class="article-heading"><a href="#saveRegister" class="headerlink" title="saveRegister"></a>saveRegister<a class="article-anchor" href="#saveRegister" aria-hidden="true"></a></h3><p>▸ <strong>saveRegister</strong>(…<code>keys</code>: string[]): <em>[string, any][]</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L50">src/context/context.ts:50</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L48">src/context/context.ts:48</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -325,7 +325,7 @@
|
||||
<p><strong>Returns:</strong> <em>[string, any][]</em></p>
|
||||
<hr>
|
||||
<h3 id="setRegister" class="article-heading"><a href="#setRegister" class="headerlink" title="setRegister"></a>setRegister<a class="article-anchor" href="#setRegister" aria-hidden="true"></a></h3><p>▸ <strong>setRegister</strong>(<code>key</code>: string, <code>value</code>: any): <em>any</em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L47">src/context/context.ts:47</a></em></p>
|
||||
<p><em>Defined in <a target="_blank" rel="noopener external nofollow noreferrer" href="https://github.com/harttle/liquidjs/blob/master/src/context/context.ts#L45">src/context/context.ts:45</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -347,7 +347,7 @@
|
||||
|
||||
</div>
|
||||
<footer class="article-footer">
|
||||
<time class="article-footer-updated" datetime="2022-11-27T05:48:42.975Z" itemprop="dateModified">Last updated: 2022-11-27</time>
|
||||
<time class="article-footer-updated" datetime="2022-11-27T09:47:17.868Z" itemprop="dateModified">Last updated: 2022-11-27</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>
|
||||
|
||||
Reference in New Issue
Block a user