Skip to content

Commit

Permalink
Updated tests and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@igoramadas
igoramadas committed Apr 8, 2019
1 parent 006bcdd commit 96202cf
Show file tree
Hide file tree
Showing 34 changed files with 398 additions and 354 deletions.
12 changes: 9 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ utilities modules for my projects. And most of the time using
too many external smaller modules might be a problem for
security and complexity (node_modules bombs anyone?).

This project is the very first step taken to debundle the [Expresser](https://github.com/igoramadas/expresser)
framework into smaller, standalone libraries.

## What types of utilities?

They're separated on the following areas:
Expand All @@ -36,3 +33,12 @@ throw an exception.

Exceptions thrown on methods might have a `friendlyMessage`
property appended to them with extra information.

## API documentation

You can browse the full API documentation at https://jaul.devv.com.

Or check these following modules that are using Jaul:

* [Expresser](https://travis-ci.org/igoramadas/expresser)
* [Monitorado](https://travis-ci.org/igoramadas/monitorado)
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

11 changes: 4 additions & 7 deletions docs/classes/_data_.datautils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> mask<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/data.ts#L42">data.ts:42</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/data.ts#L41">data.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> minify<wbr>Json</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/data.ts#L92">data.ts:92</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/data.ts#L91">data.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -186,7 +186,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>From<wbr>Strin
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/data.ts#L15">data.ts:15</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/data.ts#L14">data.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -225,7 +225,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> uuid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/data.ts#L185">data.ts:185</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/data.ts#L184">data.ts:184</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -286,9 +286,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_data_.html#_" class="tsd-kind-icon">_</a>
</li>
</ul>
</nav>
</div>
Expand Down
14 changes: 4 additions & 10 deletions docs/classes/_io_.ioutils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> copy<wbr>File<wbr>Sync</h
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/io.ts#L59">io.ts:59</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/io.ts#L60">io.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -140,7 +140,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> 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/206d371/src/io.ts#L17">io.ts:17</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/io.ts#L17">io.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -180,7 +180,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> mkdir<wbr>Recursive</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/io.ts#L69">io.ts:69</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/io.ts#L70">io.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -212,7 +212,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> sleep</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/io.ts#L115">io.ts:115</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/io.ts#L120">io.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -279,12 +279,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_io_.html#fs" class="tsd-kind-icon">fs</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_io_.html#path" class="tsd-kind-icon">path</a>
</li>
</ul>
</nav>
</div>
Expand Down
19 changes: 5 additions & 14 deletions docs/classes/_network_.networkutils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>ClientIP</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/network.ts#L67">network.ts:67</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/network.ts#L70">network.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -136,7 +136,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> getIP</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/network.ts#L15">network.ts:15</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/network.ts#L16">network.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -168,7 +168,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>SingleIPv4</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/network.ts#L38">network.ts:38</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/network.ts#L39">network.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -191,7 +191,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>SingleIPv6</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/network.ts#L52">network.ts:52</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/network.ts#L54">network.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -214,7 +214,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> ip<wbr>InRange</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/network.ts#L98">network.ts:98</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/network.ts#L101">network.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -293,15 +293,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_network_.html#_" class="tsd-kind-icon">_</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_network_.html#ipaddr" class="tsd-kind-icon">ipaddr</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_network_.html#os" class="tsd-kind-icon">os</a>
</li>
</ul>
</nav>
</div>
Expand Down
16 changes: 2 additions & 14 deletions docs/classes/_system_.systemutils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> 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/206d371/src/system.ts#L103">system.ts:103</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/system.ts#L104">system.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -124,7 +124,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/206d371/src/system.ts#L52">system.ts:52</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/system.ts#L53">system.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -197,18 +197,6 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_system_.systemmetr
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_system_.systemmetrics.html" class="tsd-kind-icon">System<wbr>Metrics</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#lastcpuload" class="tsd-kind-icon">last<wbr>Cpu<wbr>Load</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#moment" class="tsd-kind-icon">moment</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#os" class="tsd-kind-icon">os</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#path" class="tsd-kind-icon">path</a>
</li>
</ul>
</nav>
</div>
Expand Down
9 changes: 7 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ <h2 id="what-why-">What? Why?</h2>
utilities modules for my projects. And most of the time using
too many external smaller modules might be a problem for
security and complexity (node_modules bombs anyone?).</p>
<p>This project is the very first step taken to debundle the <a href="https://github.com/igoramadas/expresser">Expresser</a>
framework into smaller, standalone libraries.</p>
<h2 id="what-types-of-utilities-">What types of utilities?</h2>
<p>They&#39;re separated on the following areas:</p>
<ul>
Expand All @@ -89,6 +87,13 @@ <h4 id="if-it-fails-it-throws">If it fails, it throws</h4>
<h4 id="exceptions-with-friendly-messages">Exceptions with friendly messages</h4>
<p>Exceptions thrown on methods might have a <code>friendlyMessage</code>
property appended to them with extra information.</p>
<h2 id="api-documentation">API documentation</h2>
<p>You can browse the full API documentation at <a href="https://jaul.devv.com">https://jaul.devv.com</a>.</p>
<p>Or check these following modules that are using Jaul:</p>
<ul>
<li><a href="https://travis-ci.org/igoramadas/expresser">Expresser</a></li>
<li><a href="https://travis-ci.org/igoramadas/monitorado">Monitorado</a></li>
</ul>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down
16 changes: 2 additions & 14 deletions docs/interfaces/_system_.cpuload.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,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/206d371/src/system.ts#L41">system.ts:41</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/system.ts#L42">system.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -112,7 +112,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/206d371/src/system.ts#L43">system.ts:43</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/system.ts#L44">system.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -172,18 +172,6 @@ <h3>total</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_system_.systemmetrics.html" class="tsd-kind-icon">System<wbr>Metrics</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#lastcpuload" class="tsd-kind-icon">last<wbr>Cpu<wbr>Load</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#moment" class="tsd-kind-icon">moment</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#os" class="tsd-kind-icon">os</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#path" class="tsd-kind-icon">path</a>
</li>
</ul>
</nav>
</div>
Expand Down
14 changes: 1 addition & 13 deletions docs/interfaces/_system_.getinfooptions.html
View file
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/206d371/src/system.ts#L15">system.ts:15</a></li>
<li>Defined in <a href="https://github.com/igoramadas/jaul/blob/006bcdd/src/system.ts#L16">system.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -160,18 +160,6 @@ <h3>labels</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_system_.systemmetrics.html" class="tsd-kind-icon">System<wbr>Metrics</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#lastcpuload" class="tsd-kind-icon">last<wbr>Cpu<wbr>Load</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#moment" class="tsd-kind-icon">moment</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#os" class="tsd-kind-icon">os</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_system_.html#path" class="tsd-kind-icon">path</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit 96202cf

Please sign in to comment.