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 -5
View File
@@ -109,6 +109,7 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_template_html_.html.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_template_html_.html.html#rendersync" class="tsd-kind-icon">render<wbr>Sync</a></li>
</ul>
</section>
</div>
@@ -127,7 +128,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="_template_template_.template.html">Template</a>.<a href="_template_template_.template.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/html.ts#L8">template/html.ts:8</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/html.ts#L8">template/html.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -149,7 +150,7 @@
<div class="tsd-signature tsd-kind-icon">str<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/html.ts#L8">template/html.ts:8</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/html.ts#L8">template/html.ts:8</a></li>
</ul>
</aside>
</section>
@@ -161,7 +162,7 @@
<p>Implementation of <a href="../interfaces/_template_itemplate_.itemplate.html">ITemplate</a>.<a href="../interfaces/_template_itemplate_.itemplate.html#token">token</a></p>
<p>Inherited from <a href="_template_template_.template.html">Template</a>.<a href="_template_template_.template.html#token">token</a></p>
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/template.ts#L2">template/template.ts:2</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/template.ts#L2">template/template.ts:2</a></li>
</ul>
</aside>
</section>
@@ -172,14 +173,41 @@
<a name="render" class="tsd-anchor"></a>
<h3>render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<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>, emitter<span class="tsd-signature-symbol">: </span><a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">render<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>, emitter<span class="tsd-signature-symbol">: </span><a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_template_itemplate_.itemplate.html">ITemplate</a>.<a href="../interfaces/_template_itemplate_.itemplate.html#render">render</a></p>
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/template/html.ts#L13">template/html.ts:13</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/html.ts#L16">template/html.ts:16</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>
<li>
<h5>emitter: <a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</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">void</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="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>ctx<span class="tsd-signature-symbol">: </span><a href="_context_context_.context.html" class="tsd-signature-type">Context</a>, emitter<span class="tsd-signature-symbol">: </span><a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_template_itemplate_.itemplate.html">ITemplate</a>.<a href="../interfaces/_template_itemplate_.itemplate.html#rendersync">renderSync</a></p>
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/template/html.ts#L13">template/html.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -227,6 +255,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_template_html_.html.html#render" class="tsd-kind-icon">render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_template_html_.html.html#rendersync" class="tsd-kind-icon">render<wbr>Sync</a>
</li>
</ul>
</li>
</ul>