doc: update typedoc and README.md

This commit is contained in:
harttle
2019-08-26 23:31:53 +08:00
parent c2ba1e1f1a
commit d3f3d81e2e
82 changed files with 3276 additions and 863 deletions
+36 -9
View File
@@ -101,6 +101,7 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_template_value_.value.html#parsefilter" class="tsd-kind-icon">parse<wbr>Filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_template_value_.value.html#parsefilters" class="tsd-kind-icon">parse<wbr>Filters</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_template_value_.value.html#value" class="tsd-kind-icon">value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_template_value_.value.html#valuesync" class="tsd-kind-icon">value<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_template_value_.value.html#tokenize" class="tsd-kind-icon">tokenize</a></li>
</ul>
</section>
@@ -119,7 +120,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L8">template/value.ts:8</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L8">template/value.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -151,7 +152,7 @@
<div class="tsd-signature tsd-kind-icon">filters<span class="tsd-signature-symbol">:</span> <a href="_template_filter_filter_.filter.html" class="tsd-signature-type">Filter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L8">template/value.ts:8</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L8">template/value.ts:8</a></li>
</ul>
</aside>
</section>
@@ -161,7 +162,7 @@
<div class="tsd-signature tsd-kind-icon">initial<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L7">template/value.ts:7</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L7">template/value.ts:7</a></li>
</ul>
</aside>
</section>
@@ -171,7 +172,7 @@
<div class="tsd-signature tsd-kind-icon">strict<wbr>Filters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L6">template/value.ts:6</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L6">template/value.ts:6</a></li>
</ul>
</aside>
</section>
@@ -188,7 +189,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L31">template/value.ts:31</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L31">template/value.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -217,7 +218,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L19">template/value.ts:19</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L19">template/value.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -237,13 +238,36 @@
<a name="value" class="tsd-anchor"></a>
<h3>value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</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">value<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/template/value.ts#L50">template/value.ts:50</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L50">template/value.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="valuesync" class="tsd-anchor"></a>
<h3>value<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">value<wbr>Sync<span class="tsd-signature-symbol">(</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/template/value.ts#L57">template/value.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -266,7 +290,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/value.ts#L57">template/value.ts:57</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/value.ts#L64">template/value.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -320,6 +344,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_template_value_.value.html#value" class="tsd-kind-icon">value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_template_value_.value.html#valuesync" class="tsd-kind-icon">value<wbr>Sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_template_value_.value.html#tokenize" class="tsd-kind-icon">tokenize</a>
</li>