Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@igoramadas
igoramadas committed Feb 19, 2020
1 parent 2d5fac5 commit bb4d5ff
Show file tree
Hide file tree
Showing 10 changed files with 183 additions and 223 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

104 changes: 60 additions & 44 deletions docs/classes/_data_.datautils.html
View file

Large diffs are not rendered by default.

40 changes: 14 additions & 26 deletions docs/classes/_index_.jaul.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,60 +110,60 @@ <h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="_data_.datautils.html" class="tsd-signature-type">DataUtils</a><span class="tsd-signature-symbol"> = require(&quot;./data&quot;)</span></div>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="_data_.datautils.html" class="tsd-signature-type">DataUtils</a><span class="tsd-signature-symbol"> = DataUtils.Instance</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L25">index.ts:25</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L25">index.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="../modules/_index_.html#datautils">DataUtils</a> exposed as .data</p>
<p><a href="_data_.datautils.html">DataUtils</a> exposed as .data</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="io" class="tsd-anchor"></a>
<h3>io</h3>
<div class="tsd-signature tsd-kind-icon">io<span class="tsd-signature-symbol">:</span> <a href="_io_.ioutils.html" class="tsd-signature-type">IOUtils</a><span class="tsd-signature-symbol"> = require(&quot;./io&quot;)</span></div>
<div class="tsd-signature tsd-kind-icon">io<span class="tsd-signature-symbol">:</span> <a href="_io_.ioutils.html" class="tsd-signature-type">IOUtils</a><span class="tsd-signature-symbol"> = IOUtils.Instance</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="../modules/_index_.html#ioutils">IOUtils</a> exposed as .io</p>
<p><a href="_io_.ioutils.html">IOUtils</a> exposed as .io</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="network" class="tsd-anchor"></a>
<h3>network</h3>
<div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="_network_.networkutils.html" class="tsd-signature-type">NetworkUtils</a><span class="tsd-signature-symbol"> = require(&quot;./network&quot;)</span></div>
<div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="_network_.networkutils.html" class="tsd-signature-type">NetworkUtils</a><span class="tsd-signature-symbol"> = NetworkUtils.Instance</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L31">index.ts:31</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L31">index.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="../modules/_index_.html#networkutils">NetworkUtils</a> exposed as .network</p>
<p><a href="_network_.networkutils.html">NetworkUtils</a> exposed as .network</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="system" class="tsd-anchor"></a>
<h3>system</h3>
<div class="tsd-signature tsd-kind-icon">system<span class="tsd-signature-symbol">:</span> <a href="_system_.systemutils.html" class="tsd-signature-type">SystemUtils</a><span class="tsd-signature-symbol"> = require(&quot;./system&quot;)</span></div>
<div class="tsd-signature tsd-kind-icon">system<span class="tsd-signature-symbol">:</span> <a href="_system_.systemutils.html" class="tsd-signature-type">SystemUtils</a><span class="tsd-signature-symbol"> = SystemUtils.Instance</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L34">index.ts:34</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L34">index.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="../modules/_index_.html#systemutils">SystemUtils</a> exposed as .system</p>
<p><a href="_system_.systemutils.html">SystemUtils</a> exposed as .system</p>
</div>
</div>
</section>
Expand All @@ -173,7 +173,7 @@ <h3>version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = JSON.parse(require(&quot;fs&quot;).readFileSync(&#x60;${__dirname}/../package.json&#x60;, {encoding: &quot;utf8&quot;})).version</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L22">index.ts:22</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L22">index.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -195,7 +195,7 @@ <h3>new<wbr>Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/index.ts#L17">index.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -261,18 +261,6 @@ <h4 class="tsd-returns-title">Returns <a href="_index_.jaul.html" class="tsd-sig
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_index_.html#datautils" class="tsd-kind-icon">Data<wbr>Utils</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_index_.html#ioutils" class="tsd-kind-icon">IOUtils</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_index_.html#networkutils" class="tsd-kind-icon">Network<wbr>Utils</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_index_.html#systemutils" class="tsd-kind-icon">System<wbr>Utils</a>
</li>
</ul>
</nav>
</div>
Expand Down
68 changes: 39 additions & 29 deletions docs/classes/_io_.ioutils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,28 +89,28 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_io_.ioutils.html#copyfilesync" class="tsd-kind-icon">copy<wbr>File<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_io_.ioutils.html#getfilepath" class="tsd-kind-icon">get<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_io_.ioutils.html#mkdirrecursive" class="tsd-kind-icon">mkdir<wbr>Recursive</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_io_.ioutils.html#sleep" class="tsd-kind-icon">sleep</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_io_.ioutils.html#copyfilesync" class="tsd-kind-icon">copy<wbr>File<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_io_.ioutils.html#getfilepath" class="tsd-kind-icon">get<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_io_.ioutils.html#mkdirrecursive" class="tsd-kind-icon">mkdir<wbr>Recursive</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_io_.ioutils.html#sleep" class="tsd-kind-icon">sleep</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="copyfilesync" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> copy<wbr>File<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<h3>copy<wbr>File<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">copy<wbr>File<wbr>Sync<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/io.ts#L63">io.ts:63</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/io.ts#L69">io.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -123,31 +123,35 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>source: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The full source file path.</p>
<div class="lead">
<p>The full source file path.</p>
</div>
</div>
</li>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The full target file path.</p>
<div class="lead">
<p>The full target file path.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfilepath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>File<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<h3>get<wbr>File<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Path<span class="tsd-signature-symbol">(</span>filename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, basepath<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/igoramadas/jaul/blob/e39c708/src/io.ts#L18">io.ts:18</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/io.ts#L24">io.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -162,13 +166,17 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>filename: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The filename to be searched</p>
<div class="lead">
<p>The filename to be searched</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> basepath: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional, basepath where to look for the file.</p>
<div class="lead">
<p>Optional, basepath where to look for the file.</p>
</div>
</div>
</li>
</ul>
Expand All @@ -177,17 +185,17 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mkdirrecursive" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> mkdir<wbr>Recursive</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<h3>mkdir<wbr>Recursive</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">mkdir<wbr>Recursive<span class="tsd-signature-symbol">(</span>target<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/e39c708/src/io.ts#L73">io.ts:73</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/io.ts#L79">io.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -201,25 +209,27 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The full target path, with or without a trailing slash.</p>
<div class="lead">
<p>The full target path, with or without a trailing slash.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sleep" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> sleep</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<h3>sleep</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sleep<span class="tsd-signature-symbol">(</span>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">&lt;</span><span class="tsd-signature-type">Function</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/igoramadas/jaul/blob/e39c708/src/io.ts#L123">io.ts:123</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/2d5fac5/src/io.ts#L129">io.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -270,16 +280,16 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_io_.ioutils.html" class="tsd-kind-icon">IOUtils</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_io_.ioutils.html#copyfilesync" class="tsd-kind-icon">copy<wbr>File<wbr>Sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_io_.ioutils.html#getfilepath" class="tsd-kind-icon">get<wbr>File<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_io_.ioutils.html#mkdirrecursive" class="tsd-kind-icon">mkdir<wbr>Recursive</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_io_.ioutils.html#sleep" class="tsd-kind-icon">sleep</a>
</li>
</ul>
Expand Down
Loading

0 comments on commit bb4d5ff

Please sign in to comment.