Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JakobSegerslatt
JakobSegerslatt committed Feb 20, 2019
1 parent 6595f1b commit bfc86e9
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 27 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Expand Up @@ -11,6 +11,8 @@ Helpers for strings and objects, an accurate timer and some useful angular spefi

**`import { Timer } from 'papilion'`**

For full list of methods and classes, see Documentation

# Documentation
https://jakobsegerslatt.github.io/papilion/

Expand Down
16 changes: 8 additions & 8 deletions docs/classes/_timer_.timer.html
View file
Expand Up @@ -139,7 +139,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L26">timer.ts:26</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L26">timer.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -164,7 +164,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> duration</h3>
<div class="tsd-signature tsd-kind-icon">duration<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/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L26">timer.ts:26</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L26">timer.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -179,7 +179,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> start<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Time<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/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L23">timer.ts:23</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L23">timer.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> timer<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">timer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Timeout</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L17">timer.ts:17</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L17">timer.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -209,7 +209,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> total<wbr>Ticks</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Ticks<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/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L20">timer.ts:20</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L20">timer.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -231,7 +231,7 @@ <h3>reset</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L39">timer.ts:39</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L39">timer.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -255,7 +255,7 @@ <h3>start</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L48">timer.ts:48</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L48">timer.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -286,7 +286,7 @@ <h3>stop</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/timer.ts#L76">timer.ts:76</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/timer.ts#L76">timer.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
1 change: 1 addition & 0 deletions docs/index.html
View file
Expand Up @@ -71,6 +71,7 @@ <h1 id="papilion">papilion</h1>
<h1 id="how-to-use">How to use</h1>
<p><strong><code>npm i papilion</code></strong></p>
<p><strong><code>import { Timer } from &#39;papilion&#39;</code></strong></p>
<p>For full list of methods and classes, see Documentation</p>
<h1 id="documentation">Documentation</h1>
<p><a href="https://jakobsegerslatt.github.io/papilion/">https://jakobsegerslatt.github.io/papilion/</a></p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_angular_utils_.html
View file
Expand Up @@ -91,7 +91,7 @@ <h3>throw<wbr>IfAlready<wbr>Loaded</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/angular-utils.ts#L16">angular-utils.ts:16</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/angular-utils.ts#L16">angular-utils.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_component_decorators_.html
View file
Expand Up @@ -91,7 +91,7 @@ <h3>Storage</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/component-decorators.ts#L7">component-decorators.ts:7</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/component-decorators.ts#L7">component-decorators.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
33 changes: 21 additions & 12 deletions docs/modules/_object_utils_.html
View file
Expand Up @@ -98,7 +98,7 @@ <h3>clear<wbr>Nulls</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L28">object-utils.ts:28</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L28">object-utils.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -152,9 +152,11 @@ <h3>clone</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L52">object-utils.ts:52</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L56">object-utils.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
Expand All @@ -168,6 +170,8 @@ <h5>obj: <span class="tsd-signature-type">T</span><span class="tsd-signature-sym
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>A copy of @param obj
It can be an array, object, class or primitive type.</p>
</li>
</ul>
</section>
Expand All @@ -181,7 +185,7 @@ <h3>convert<wbr>ToTyped<wbr>Class</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L69">object-utils.ts:69</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L73">object-utils.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -216,13 +220,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
<a name="findkeyforvalue" class="tsd-anchor"></a>
<h3>find<wbr>Key<wbr>For<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">find<wbr>Key<wbr>For<wbr>Value<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
<li class="tsd-signature tsd-kind-icon">find<wbr>Key<wbr>For<wbr>Value<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L87">object-utils.ts:87</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L91">object-utils.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -246,7 +250,12 @@ <h5>value: <span class="tsd-signature-type">any</span></h5>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">number</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
</li>
</ul>
</section>
Expand All @@ -260,7 +269,7 @@ <h3>flatten<wbr>Tree</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L104">object-utils.ts:104</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L108">object-utils.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -299,13 +308,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
<a name="grouparraybyproperty" class="tsd-anchor"></a>
<h3>group<wbr>Array<wbr>ByProperty</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">group<wbr>Array<wbr>ByProperty&lt;T&gt;<span class="tsd-signature-symbol">(</span>array<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span>, propertyName<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">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></li>
<li class="tsd-signature tsd-kind-icon">group<wbr>Array<wbr>ByProperty&lt;T&gt;<span class="tsd-signature-symbol">(</span>array<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L119">object-utils.ts:119</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L123">object-utils.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -329,7 +338,7 @@ <h5>array: <span class="tsd-signature-type">T</span><span class="tsd-signature-s
</div>
</li>
<li>
<h5>propertyName: <span class="tsd-signature-type">string</span></h5>
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h4>
Expand All @@ -346,7 +355,7 @@ <h3>is<wbr>Object</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L188">object-utils.ts:188</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L196">object-utils.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -374,7 +383,7 @@ <h3>remove<wbr>Duplicates</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/object-utils.ts#L199">object-utils.ts:199</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/object-utils.ts#L207">object-utils.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/_string_utils_.html
View file
Expand Up @@ -95,7 +95,7 @@ <h3>contains</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/string-utils.ts#L20">string-utils.ts:20</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/string-utils.ts#L20">string-utils.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -127,7 +127,7 @@ <h3>create<wbr>Guid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/string-utils.ts#L6">string-utils.ts:6</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/string-utils.ts#L6">string-utils.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -148,7 +148,7 @@ <h3>is<wbr>Not<wbr>Nullor<wbr>Empty</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/string-utils.ts#L36">string-utils.ts:36</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/string-utils.ts#L36">string-utils.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -183,7 +183,7 @@ <h3>pascal<wbr>Case</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/string-utils.ts#L45">string-utils.ts:45</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/string-utils.ts#L45">string-utils.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -215,7 +215,7 @@ <h3>trim<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/5f6099f/src/string-utils.ts#L56">string-utils.ts:56</a></li>
<li>Defined in <a href="https://github.com/JakobSegerslatt/papilion/blob/6595f1b/src/string-utils.ts#L56">string-utils.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit bfc86e9

Please sign in to comment.