Labyricorn/liquidjs
1
0
Fork 0
mirror of https://github.com/harttle/liquidjs.git synced 2026-09-16 12:50:38 -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/modules/_fs_browser_.html
+52 -4
View File
@@ -75,7 +75,9 @@
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#domresolve" class="tsd-kind-icon">dom<wbr>Resolve</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#exists" class="tsd-kind-icon">exists</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#existssync" class="tsd-kind-icon">exists<wbr>Sync</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#readfile" class="tsd-kind-icon">read<wbr>File</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_fs_browser_.html#resolve" class="tsd-kind-icon">resolve</a></li>
</ul>
</section>
@@ -94,7 +96,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/browser.ts#L4">fs/browser.ts:4</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L4">fs/browser.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -120,13 +122,30 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/browser.ts#L47">fs/browser.ts:47</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L57">fs/browser.ts:57</a></li>
</ul>
</aside>
<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="existssync" class="tsd-anchor"></a>
<h3>exists<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">exists<wbr>Sync<span class="tsd-signature-symbol">(</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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L61">fs/browser.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="readfile" class="tsd-anchor"></a>
<h3>read<wbr>File</h3>
@@ -137,7 +156,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/browser.ts#L29">fs/browser.ts:29</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L29">fs/browser.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -150,6 +169,29 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="readfilesync" class="tsd-anchor"></a>
<h3>read<wbr>File<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">read<wbr>File<wbr>Sync<span class="tsd-signature-symbol">(</span>url<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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L47">fs/browser.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <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>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="resolve" class="tsd-anchor"></a>
<h3>resolve</h3>
@@ -160,7 +202,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/fs/browser.ts#L19">fs/browser.ts:19</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/fs/browser.ts#L19">fs/browser.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -200,9 +242,15 @@
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_fs_browser_.html#exists" class="tsd-kind-icon">exists</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_fs_browser_.html#existssync" class="tsd-kind-icon">exists<wbr>Sync</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_fs_browser_.html#readfile" class="tsd-kind-icon">read<wbr>File</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_fs_browser_.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_fs_browser_.html#resolve" class="tsd-kind-icon">resolve</a>
</li>