Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
igoramadas committed Sep 27, 2020
1 parent 10c0092 commit c35f549
Show file tree
Hide file tree
Showing 15 changed files with 97 additions and 2,725 deletions.
2,680 changes: 1 addition & 2,679 deletions docs/assets/css/main.css

Large diffs are not rendered by default.

52 changes: 51 additions & 1 deletion docs/assets/js/main.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/js/search.json

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/_src_data_.datautils.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>mask<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L91">src/data.ts:91</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L91">src/data.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -163,7 +163,7 @@ <h3>minify<wbr>Json</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L141">src/data.ts:141</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L141">src/data.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>remove<wbr>From<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L20">src/data.ts:20</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L20">src/data.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -248,7 +248,7 @@ <h3>replace<wbr>Tags</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L47">src/data.ts:47</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L47">src/data.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -299,7 +299,7 @@ <h3>strip<wbr>Html</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L238">src/data.ts:238</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L238">src/data.ts:238</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -336,7 +336,7 @@ <h3>uuid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L368">src/data.ts:368</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L368">src/data.ts:368</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/_src_index_.jaul.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="_src_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/4dc954e/src/index.ts#L25">src/index.ts:25</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L25">src/index.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -128,7 +128,7 @@ <h3>io</h3>
<div class="tsd-signature tsd-kind-icon">io<span class="tsd-signature-symbol">:</span> <a href="_src_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/4dc954e/src/index.ts#L28">src/index.ts:28</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L28">src/index.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -143,7 +143,7 @@ <h3>network</h3>
<div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="_src_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/4dc954e/src/index.ts#L31">src/index.ts:31</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L31">src/index.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -158,7 +158,7 @@ <h3>system</h3>
<div class="tsd-signature tsd-kind-icon">system<span class="tsd-signature-symbol">:</span> <a href="_src_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/4dc954e/src/index.ts#L34">src/index.ts:34</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L34">src/index.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
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/4dc954e/src/index.ts#L22">src/index.ts:22</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L22">src/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/4dc954e/src/index.ts#L17">src/index.ts:17</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/index.ts#L17">src/index.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/_src_io_.ioutils.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <h3>copy<wbr>File<wbr>Sync</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L67">src/io.ts:67</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L67">src/io.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -151,7 +151,7 @@ <h3>get<wbr>File<wbr>Path</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L22">src/io.ts:22</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L22">src/io.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3>mkdir<wbr>Recursive</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L77">src/io.ts:77</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L77">src/io.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -229,7 +229,7 @@ <h3>sleep</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L127">src/io.ts:127</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L127">src/io.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/_src_network_.networkutils.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h3>get<wbr>ClientIP</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/network.ts#L74">src/network.ts:74</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/network.ts#L74">src/network.ts:74</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -145,7 +145,7 @@ <h3>getIP</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/network.ts#L20">src/network.ts:20</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/network.ts#L20">src/network.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -179,7 +179,7 @@ <h3>get<wbr>SingleIPv4</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/network.ts#L43">src/network.ts:43</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/network.ts#L43">src/network.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -202,7 +202,7 @@ <h3>get<wbr>SingleIPv6</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/network.ts#L58">src/network.ts:58</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/network.ts#L58">src/network.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -225,7 +225,7 @@ <h3>ip<wbr>InRange</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/network.ts#L120">src/network.ts:120</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/network.ts#L120">src/network.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/_src_system_.systemutils.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h3>get<wbr>Cpu<wbr>Load</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L110">src/system.ts:110</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L110">src/system.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -131,7 +131,7 @@ <h3>get<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L59">src/system.ts:59</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L59">src/system.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_src_system_.cpuload.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3>idle</h3>
<div class="tsd-signature tsd-kind-icon">idle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L41">src/system.ts:41</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L41">src/system.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -119,7 +119,7 @@ <h3>total</h3>
<div class="tsd-signature tsd-kind-icon">total<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L43">src/system.ts:43</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L43">src/system.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/_src_system_.getinfooptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3>labels</h3>
<div class="tsd-signature tsd-kind-icon">labels<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/igoramadas/jaul/blob/4dc954e/src/system.ts#L13">src/system.ts:13</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L13">src/system.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
18 changes: 9 additions & 9 deletions docs/interfaces/_src_system_.systemmetrics.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h3>cpu<wbr>Cores</h3>
<div class="tsd-signature tsd-kind-icon">cpu<wbr>Cores<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L33">src/system.ts:33</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L33">src/system.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -126,7 +126,7 @@ <h3>hostname</h3>
<div class="tsd-signature tsd-kind-icon">hostname<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/igoramadas/jaul/blob/4dc954e/src/system.ts#L21">src/system.ts:21</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L21">src/system.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -141,7 +141,7 @@ <h3>load<wbr>Avg</h3>
<div class="tsd-signature tsd-kind-icon">load<wbr>Avg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L31">src/system.ts:31</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L31">src/system.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -156,7 +156,7 @@ <h3>memory<wbr>Total</h3>
<div class="tsd-signature tsd-kind-icon">memory<wbr>Total<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L27">src/system.ts:27</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L27">src/system.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -171,7 +171,7 @@ <h3>memory<wbr>Usage</h3>
<div class="tsd-signature tsd-kind-icon">memory<wbr>Usage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L29">src/system.ts:29</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L29">src/system.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -186,7 +186,7 @@ <h3>platform</h3>
<div class="tsd-signature tsd-kind-icon">platform<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/igoramadas/jaul/blob/4dc954e/src/system.ts#L25">src/system.ts:25</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L25">src/system.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -201,7 +201,7 @@ <h3>process</h3>
<div class="tsd-signature tsd-kind-icon">process<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/system.ts#L35">src/system.ts:35</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L35">src/system.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -216,7 +216,7 @@ <h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<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/igoramadas/jaul/blob/4dc954e/src/system.ts#L23">src/system.ts:23</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L23">src/system.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -231,7 +231,7 @@ <h3>uptime</h3>
<div class="tsd-signature tsd-kind-icon">uptime<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/igoramadas/jaul/blob/4dc954e/src/system.ts#L19">src/system.ts:19</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/system.ts#L19">src/system.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_src_data_.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h3>_</h3>
<div class="tsd-signature tsd-kind-icon">_<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/data.ts#L3">src/data.ts:3</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/data.ts#L3">src/data.ts:3</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/_src_io_.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>fs</h3>
<div class="tsd-signature tsd-kind-icon">fs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fs&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L3">src/io.ts:3</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L3">src/io.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -102,7 +102,7 @@ <h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformPath</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/4dc954e/src/io.ts#L4">src/io.ts:4</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/10c0092/src/io.ts#L4">src/io.ts:4</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit c35f549

Please sign in to comment.