Skip to content

Commit

Permalink
📚 Autogenerated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas Gramlich committed Dec 4, 2017
1 parent d29e14d commit 21ee47c
Show file tree
Hide file tree
Showing 2 changed files with 169 additions and 4 deletions.
158 changes: 154 additions & 4 deletions docs/globals.html
View file
Expand Up @@ -68,6 +68,8 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="globals.html#diff" class="tsd-kind-icon">Diff</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#omit" class="tsd-kind-icon">Omit</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#tconstructible" class="tsd-kind-icon">TConstructible</a></li>
</ul>
</section>
Expand All @@ -76,6 +78,9 @@ <h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="globals.html#noop" class="tsd-kind-icon">NOOP</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#makearray" class="tsd-kind-icon">make<wbr>Array</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#omit" class="tsd-kind-icon">omit</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#pick" class="tsd-kind-icon">pick</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#pluck" class="tsd-kind-icon">pluck</a></li>
<li class="tsd-kind-function"><a href="globals.html#wait" class="tsd-kind-icon">wait</a></li>
</ul>
</section>
Expand All @@ -84,13 +89,38 @@ <h3>Functions</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="diff" class="tsd-anchor"></a>
<h3>Diff</h3>
<div class="tsd-signature tsd-kind-icon">Diff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">({ [P in T]: P; } &amp; { [P in U]: never; } &amp; { [x: string]: never; })[T]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/utils/omit.ts#L3">src/utils/omit.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="omit" class="tsd-anchor"></a>
<h3>Omit</h3>
<div class="tsd-signature tsd-kind-icon">Omit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/utils/omit.ts#L4">src/utils/omit.ts:4</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="tconstructible" class="tsd-anchor"></a>
<h3>TConstructible</h3>
<div class="tsd-signature tsd-kind-icon">TConstructible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/09af984/src/types/constructible.ts#L1">src/types/constructible.ts:1</a></li>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/types/constructible.ts#L1">src/types/constructible.ts:1</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -112,7 +142,7 @@ <h3>NOOP</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/09af984/src/constants/noop.ts#L1">src/constants/noop.ts:1</a></li>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/constants/noop.ts#L1">src/constants/noop.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -129,7 +159,7 @@ <h3>make<wbr>Array</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/09af984/src/utils/make-array.ts#L3">src/utils/make-array.ts:3</a></li>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/utils/make-array.ts#L3">src/utils/make-array.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand All @@ -148,6 +178,111 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="omit" class="tsd-anchor"></a>
<h3>omit</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">omit&lt;T, K&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="globals.html#omit" class="tsd-signature-type">Omit</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</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/bluebirds-blue-jay/utils/blob/024652f/src/utils/omit.ts#L6">src/utils/omit.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
<li>
<h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof T</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>obj: <span class="tsd-signature-type">T</span></h5>
</li>
<li>
<h5>keys: <span class="tsd-signature-type">K</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="globals.html#omit" class="tsd-signature-type">Omit</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="pick" class="tsd-anchor"></a>
<h3>pick</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">pick&lt;T, K&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</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/bluebirds-blue-jay/utils/blob/024652f/src/utils/pick.ts#L3">src/utils/pick.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
<li>
<h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof T</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>obj: <span class="tsd-signature-type">T</span></h5>
</li>
<li>
<h5>keys: <span class="tsd-signature-type">K</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="pluck" class="tsd-anchor"></a>
<h3>pluck</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">pluck&lt;T, K&gt;<span class="tsd-signature-symbol">(</span>objs<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">K</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T[K]</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/bluebirds-blue-jay/utils/blob/024652f/src/utils/pluck.ts#L3">src/utils/pluck.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
<li>
<h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof T</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>objs: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>key: <span class="tsd-signature-type">K</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T[K]</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="wait" class="tsd-anchor"></a>
<h3>wait</h3>
Expand All @@ -158,7 +293,7 @@ <h3>wait</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/09af984/src/utils/wait.ts#L1">src/utils/wait.ts:1</a></li>
<li>Defined in <a href="https://github.com/bluebirds-blue-jay/utils/blob/024652f/src/utils/wait.ts#L1">src/utils/wait.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -183,6 +318,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-type-alias">
<a href="globals.html#diff" class="tsd-kind-icon">Diff</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#omit" class="tsd-kind-icon">Omit</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#tconstructible" class="tsd-kind-icon">TConstructible</a>
</li>
Expand All @@ -192,6 +333,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#makearray" class="tsd-kind-icon">make<wbr>Array</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#omit" class="tsd-kind-icon">omit</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#pick" class="tsd-kind-icon">pick</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#pluck" class="tsd-kind-icon">pluck</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#wait" class="tsd-kind-icon">wait</a>
</li>
Expand Down
15 changes: 15 additions & 0 deletions docs/index.html
View file
Expand Up @@ -100,6 +100,12 @@ <h2 id="documentation">Documentation</h2>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-type-alias">
<a href="globals.html#diff" class="tsd-kind-icon">Diff</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#omit" class="tsd-kind-icon">Omit</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#tconstructible" class="tsd-kind-icon">TConstructible</a>
</li>
Expand All @@ -109,6 +115,15 @@ <h2 id="documentation">Documentation</h2>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#makearray" class="tsd-kind-icon">make<wbr>Array</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#omit" class="tsd-kind-icon">omit</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#pick" class="tsd-kind-icon">pick</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#pluck" class="tsd-kind-icon">pluck</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#wait" class="tsd-kind-icon">wait</a>
</li>
Expand Down

0 comments on commit 21ee47c

Please sign in to comment.