Skip to content

Commit

Permalink
docs(*): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hamilton committed Aug 28, 2019
1 parent a3c211e commit d434501
Show file tree
Hide file tree
Showing 56 changed files with 729 additions and 2,330 deletions.
2 changes: 1 addition & 1 deletion docs/CNAME
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
o.hammy2899.dev
o.hammy2899.dev
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@ <h1> o</h1>
<h1><a href="https://github.com/hammy2899/o">o</a></h1>
</a>
<p>common object helper functions written in TypeScript which can be used in <a href="https://nodejs.org/en/">NodeJS</a> and the browser (supports ES6).</p>
<p><a href="https://travis-ci.org/hammy2899/o"><img src="https://travis-ci.org/hammy2899/o.svg?branch=master" alt="Build Status"></a>
<p><a href="https://github.com/hammy2899/o/actions"><img src="https://github.com/hammy2899/o/workflows/CI/badge.svg" alt="GitHub Actions Status"></a>
<a href="https://coveralls.io/github/hammy2899/o?branch=master"><img src="https://coveralls.io/repos/github/hammy2899/o/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://www.npmjs.com/package/o"><img src="https://img.shields.io/npm/v/o.svg" alt="npm version"></a>
<a href="https://github.com/hammy2899/o/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/hammy2899/o.svg" alt="license"></a></p>
<a href="https://github.com/hammy2899/o/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/hammy2899/o.svg" alt="license"></a>
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a></p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h3>Installation</h3>
</a>
Expand Down Expand Up @@ -151,7 +152,7 @@ <h3>Documentation</h3>
<h3>Contributing</h3>
</a>
<p>All functions are documented with <a href="https://typedoc.org">TypeDoc</a> and are fully commented explaining how they works. If you want to
contribute feel free to open a PR. When you open a PR please set the base branch as <a href="https://github.com/hammy2899/o/tree/develop"><code>develop</code></a> and please make sure <code>yarn test</code> and <code>yarn lint</code> both pass
contribute feel free to open a PR. When you open a PR please make sure <code>yarn test</code> and <code>yarn lint</code> both pass
with no errors and if any tests fail or any linting issues are raised please fix them accordingly.</p>
</div>
</div>
Expand Down
44 changes: 22 additions & 22 deletions docs/interfaces/_types_.cleanoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> follow</h3>
<div class="tsd-signature tsd-kind-icon">follow<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L6">types.ts:6</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/a3c211e/src/types.ts#L6">types.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -129,27 +129,15 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> follow</h3>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.eachcallback.html" class="tsd-kind-icon">Each<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.eachoptions.html" class="tsd-kind-icon">Each<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.everycallback.html" class="tsd-kind-icon">Every<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.everyoptions.html" class="tsd-kind-icon">Every<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.filtercallback.html" class="tsd-kind-icon">Filter<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.filteroptions.html" class="tsd-kind-icon">Filter<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.findcallback.html" class="tsd-kind-icon">Find<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.findoptions.html" class="tsd-kind-icon">Find<wbr>Options</a>
</li>
Expand All @@ -165,9 +153,6 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> follow</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.keysoptions.html" class="tsd-kind-icon">Keys<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.mapcallback.html" class="tsd-kind-icon">Map<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.mapoptions.html" class="tsd-kind-icon">Map<wbr>Options</a>
</li>
Expand All @@ -177,15 +162,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> follow</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.sliceoptions.html" class="tsd-kind-icon">Slice<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.somecallback.html" class="tsd-kind-icon">Some<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.someoptions.html" class="tsd-kind-icon">Some<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.sortcallback.html" class="tsd-kind-icon">Sort<wbr>Callback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.sortelement.html" class="tsd-kind-icon">Sort<wbr>Element</a>
</li>
Expand All @@ -195,6 +174,27 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> follow</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_types_.valuesoptions.html" class="tsd-kind-icon">Values<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#eachcallback" class="tsd-kind-icon">Each<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#everycallback" class="tsd-kind-icon">Every<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#filtercallback" class="tsd-kind-icon">Filter<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#findcallback" class="tsd-kind-icon">Find<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#mapcallback" class="tsd-kind-icon">Map<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#somecallback" class="tsd-kind-icon">Some<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#sortcallback" class="tsd-kind-icon">Sort<wbr>Callback</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit d434501

Please sign in to comment.