mirror of
https://github.com/harttle/liquidjs.git
synced 2026-09-16 21:00:40 -07:00
doc: update typedoc and README.md
This commit is contained in:
harttle
@@ -102,15 +102,23 @@
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#evalvalue" class="tsd-kind-icon">eval<wbr>Value</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#evalvaluesync" class="tsd-kind-icon">eval<wbr>Value<wbr>Sync</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#express" class="tsd-kind-icon">express</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#gettemplate" class="tsd-kind-icon">get<wbr>Template</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#gettemplatesync" class="tsd-kind-icon">get<wbr>Template<wbr>Sync</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_liquid_.liquid.html#lookuperror" class="tsd-kind-icon">lookup<wbr>Error</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#parse" class="tsd-kind-icon">parse</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#parseandrender" class="tsd-kind-icon">parse<wbr>And<wbr>Render</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#parseandrendersync" class="tsd-kind-icon">parse<wbr>And<wbr>Render<wbr>Sync</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#plugin" class="tsd-kind-icon">plugin</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#registerfilter" class="tsd-kind-icon">register<wbr>Filter</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#registertag" class="tsd-kind-icon">register<wbr>Tag</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#render" class="tsd-kind-icon">render</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#renderfile" class="tsd-kind-icon">render<wbr>File</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#renderfilesync" class="tsd-kind-icon">render<wbr>File<wbr>Sync</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_liquid_.liquid.html#rendersync" class="tsd-kind-icon">render<wbr>Sync</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_liquid_.liquid.html#respectcache" class="tsd-kind-icon">respect<wbr>Cache</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="_liquid_.liquid.html#setcache" class="tsd-kind-icon">set<wbr>Cache</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
@@ -128,7 +136,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L25">liquid.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L28">liquid.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -150,7 +158,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L23">liquid.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L26">liquid.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -160,7 +168,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">fs<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_fs_ifs_.ifs.html" class="tsd-signature-type">IFS</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L25">liquid.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L28">liquid.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -170,7 +178,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_liquid_options_.normalizedfulloptions.html" class="tsd-signature-type">NormalizedFullOptions</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L20">liquid.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L23">liquid.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -180,7 +188,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">parser<span class="tsd-signature-symbol">:</span> <a href="_parser_parser_.parser.html" class="tsd-signature-type">Parser</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L22">liquid.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L25">liquid.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -190,7 +198,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">renderer<span class="tsd-signature-symbol">:</span> <a href="_render_render_.render.html" class="tsd-signature-type">Render</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L21">liquid.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L24">liquid.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -200,7 +208,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">tokenizer<span class="tsd-signature-symbol">:</span> <a href="_parser_tokenizer_.tokenizer.html" class="tsd-signature-type">Tokenizer</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L24">liquid.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L27">liquid.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -211,13 +219,39 @@
|
||||
<a name="evalvalue" class="tsd-anchor"></a>
|
||||
<h3>eval<wbr>Value</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">eval<wbr>Value<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ctx<span class="tsd-signature-symbol">: </span><a href="_context_context_.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">eval<wbr>Value<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ctx<span class="tsd-signature-symbol">: </span><a href="_context_context_.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L75">liquid.ts:75</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L98">liquid.ts:98</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>str: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>ctx: <a href="_context_context_.context.html" class="tsd-signature-type">Context</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="evalvaluesync" class="tsd-anchor"></a>
|
||||
<h3>eval<wbr>Value<wbr>Sync</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">eval<wbr>Value<wbr>Sync<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ctx<span class="tsd-signature-symbol">: </span><a href="_context_context_.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L102">liquid.ts:102</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -243,7 +277,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L87">liquid.ts:87</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L115">liquid.ts:115</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
||||
@@ -254,13 +288,13 @@
|
||||
<a name="gettemplate" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Template</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Template<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Template<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L50">liquid.ts:50</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L76">liquid.ts:76</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -272,7 +306,59 @@
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="gettemplatesync" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Template<wbr>Sync</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Template<wbr>Sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L62">liquid.ts:62</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a name="lookuperror" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> lookup<wbr>Error</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">lookup<wbr>Error<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roots<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L123">liquid.ts:123</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>roots: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -286,7 +372,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L37">liquid.ts:37</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L40">liquid.ts:40</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -306,13 +392,13 @@
|
||||
<a name="parseandrender" class="tsd-anchor"></a>
|
||||
<h3>parse<wbr>And<wbr>Render</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">parse<wbr>And<wbr>Render<span class="tsd-signature-symbol">(</span>html<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">parse<wbr>And<wbr>Render<span class="tsd-signature-symbol">(</span>html<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L46">liquid.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L54">liquid.ts:54</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -321,7 +407,7 @@
|
||||
<h5>html: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ctx: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
@@ -331,6 +417,35 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="parseandrendersync" class="tsd-anchor"></a>
|
||||
<h3>parse<wbr>And<wbr>Render<wbr>Sync</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">parse<wbr>And<wbr>Render<wbr>Sync<span class="tsd-signature-symbol">(</span>html<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L58">liquid.ts:58</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>html: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="plugin" class="tsd-anchor"></a>
|
||||
<h3>plugin</h3>
|
||||
@@ -341,7 +456,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L84">liquid.ts:84</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L112">liquid.ts:112</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -385,7 +500,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L78">liquid.ts:78</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L106">liquid.ts:106</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -411,7 +526,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L81">liquid.ts:81</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L109">liquid.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -437,7 +552,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L41">liquid.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L44">liquid.ts:44</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -466,7 +581,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/liquid.ts#L70">liquid.ts:70</a></li>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L89">liquid.ts:89</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -485,6 +600,164 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="renderfilesync" class="tsd-anchor"></a>
|
||||
<h3>render<wbr>File<wbr>Sync</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">render<wbr>File<wbr>Sync<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L93">liquid.ts:93</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ctx: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="rendersync" class="tsd-anchor"></a>
|
||||
<h3>render<wbr>Sync</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">render<wbr>Sync<span class="tsd-signature-symbol">(</span>tpl<span class="tsd-signature-symbol">: </span><a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L49">liquid.ts:49</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>tpl: <a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scope: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/_liquid_options_.liquidoptions.html" class="tsd-signature-type">LiquidOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a name="respectcache" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> respect<wbr>Cache</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">respect<wbr>Cache<span class="tsd-signature-symbol">(</span>filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resolver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">respect<wbr>Cache<span class="tsd-signature-symbol">(</span>filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resolver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L136">liquid.ts:136</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>filepath: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>resolver: <span class="tsd-signature-type">function</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L137">liquid.ts:137</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>filepath: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>resolver: <span class="tsd-signature-type">function</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-siganture">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a name="setcache" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> set<wbr>Cache</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">set<wbr>Cache<T><span class="tsd-signature-symbol">(</span>filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tpl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/liquid.ts#L130">liquid.ts:130</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/_liquid_.html#gettemplateresult" class="tsd-signature-type">GetTemplateResult</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>filepath: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>tpl: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
@@ -529,18 +802,30 @@
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#evalvalue" class="tsd-kind-icon">eval<wbr>Value</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#evalvaluesync" class="tsd-kind-icon">eval<wbr>Value<wbr>Sync</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#express" class="tsd-kind-icon">express</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#gettemplate" class="tsd-kind-icon">get<wbr>Template</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#gettemplatesync" class="tsd-kind-icon">get<wbr>Template<wbr>Sync</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a href="_liquid_.liquid.html#lookuperror" class="tsd-kind-icon">lookup<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#parse" class="tsd-kind-icon">parse</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#parseandrender" class="tsd-kind-icon">parse<wbr>And<wbr>Render</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#parseandrendersync" class="tsd-kind-icon">parse<wbr>And<wbr>Render<wbr>Sync</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#plugin" class="tsd-kind-icon">plugin</a>
|
||||
</li>
|
||||
@@ -556,10 +841,25 @@
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#renderfile" class="tsd-kind-icon">render<wbr>File</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#renderfilesync" class="tsd-kind-icon">render<wbr>File<wbr>Sync</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_liquid_.liquid.html#rendersync" class="tsd-kind-icon">render<wbr>Sync</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a href="_liquid_.liquid.html#respectcache" class="tsd-kind-icon">respect<wbr>Cache</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a href="_liquid_.liquid.html#setcache" class="tsd-kind-icon">set<wbr>Cache</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported">
|
||||
<a href="../modules/_liquid_.html#gettemplateresult" class="tsd-kind-icon">Get<wbr>Template<wbr>Result</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user