Labyricorn/liquidjs
1
0
Fork 0
mirror of https://github.com/harttle/liquidjs.git synced 2026-09-20 06:50:47 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: update typedoc and README.md

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
doc/interfaces/_fs_ifs_.ifs.html
+73 -3
View File
@@ -85,7 +85,9 @@
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_fs_ifs_.ifs.html#exists" class="tsd-kind-icon">exists</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_fs_ifs_.ifs.html#existssync" class="tsd-kind-icon">exists<wbr>Sync</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_fs_ifs_.ifs.html#readfile" class="tsd-kind-icon">read<wbr>File</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_fs_ifs_.ifs.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_fs_ifs_.ifs.html#resolve" class="tsd-kind-icon">resolve</a></li>
</ul>
</section>
@@ -100,7 +102,7 @@
<div class="tsd-signature tsd-kind-icon">exists<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/ifs.ts#L2">fs/ifs.ts:2</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/ifs.ts#L2">fs/ifs.ts:2</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -125,13 +127,44 @@
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="existssync" class="tsd-anchor"></a>
<h3>exists<wbr>Sync</h3>
<div class="tsd-signature tsd-kind-icon">exists<wbr>Sync<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/ifs.ts#L4">fs/ifs.ts:4</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>filepath<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-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filepath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="readfile" class="tsd-anchor"></a>
<h3>read<wbr>File</h3>
<div class="tsd-signature tsd-kind-icon">read<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/ifs.ts#L3">fs/ifs.ts:3</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/ifs.ts#L3">fs/ifs.ts:3</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -156,13 +189,44 @@
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="readfilesync" class="tsd-anchor"></a>
<h3>read<wbr>File<wbr>Sync</h3>
<div class="tsd-signature tsd-kind-icon">read<wbr>File<wbr>Sync<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/ifs.ts#L5">fs/ifs.ts:5</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>filepath<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-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filepath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="resolve" class="tsd-anchor"></a>
<h3>resolve</h3>
<div class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/ifs.ts#L4">fs/ifs.ts:4</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/ifs.ts#L6">fs/ifs.ts:6</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -216,9 +280,15 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_fs_ifs_.ifs.html#exists" class="tsd-kind-icon">exists</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_fs_ifs_.ifs.html#existssync" class="tsd-kind-icon">exists<wbr>Sync</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_fs_ifs_.ifs.html#readfile" class="tsd-kind-icon">read<wbr>File</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_fs_ifs_.ifs.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_fs_ifs_.ifs.html#resolve" class="tsd-kind-icon">resolve</a>
</li>