Skip to content

Commit

Permalink
chore(release): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hamilton committed Aug 6, 2019
1 parent fad38e2 commit 264baf1
Show file tree
Hide file tree
Showing 61 changed files with 2,478 additions and 939 deletions.
3,008 changes: 2,238 additions & 770 deletions docs/assets/css/main.css
View file

Large diffs are not rendered by default.

7 changes: 0 additions & 7 deletions docs/assets/css/main.css.map
View file

This file was deleted.

Binary file modified docs/assets/images/icons.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/icons@2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 1 addition & 5 deletions docs/assets/js/main.js
View file

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -275,7 +276,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
Expand Down
55 changes: 41 additions & 14 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,28 +65,46 @@ <h1> o</h1>
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p><img src="https://unpkg.com/o@1.1.3/logo.png" alt="o Logo"></p>
<h1 id="o"><a href="https://github.com/hammy2899/o">o</a></h1>
<a href="#a-hrefhttpsgithubcomhammy2899ooa" id="a-hrefhttpsgithubcomhammy2899ooa" style="color: inherit; text-decoration: none;">
<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>
<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>
<h3 id="installation">Installation</h3>
<h4 id="npm"><a href="https://npmjs.com">NPM</a></h4>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h3>Installation</h3>
</a>
<a href="#a-hrefhttpsnpmjscomnpma" id="a-hrefhttpsnpmjscomnpma" style="color: inherit; text-decoration: none;">
<h4><a href="https://npmjs.com">NPM</a></h4>
</a>
<pre><code class="language-bash">$ npm install o</code></pre>
<h4 id="yarn"><a href="https://yarnpkg.com">Yarn</a></h4>
<a href="#a-hrefhttpsyarnpkgcomyarna" id="a-hrefhttpsyarnpkgcomyarna" style="color: inherit; text-decoration: none;">
<h4><a href="https://yarnpkg.com">Yarn</a></h4>
</a>
<pre><code class="language-bash">$ yarn add o</code></pre>
<h3 id="usage">Usage</h3>
<h4 id="typescript">TypeScript</h4>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h3>Usage</h3>
</a>
<a href="#typescript" id="typescript" style="color: inherit; text-decoration: none;">
<h4>TypeScript</h4>
</a>
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> o <span class="hljs-keyword">from</span> <span class="hljs-string">'o'</span>;
<span class="hljs-comment">// or require specific functions</span>
<span class="hljs-keyword">import</span> { is, empty } <span class="hljs-keyword">from</span> <span class="hljs-string">'o'</span>;</code></pre>
<h4 id="nodejs">NodeJS</h4>
<a href="#nodejs" id="nodejs" style="color: inherit; text-decoration: none;">
<h4>NodeJS</h4>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> o = <span class="hljs-built_in">require</span>(<span class="hljs-string">'o'</span>);
<span class="hljs-comment">// or require specific functions</span>
<span class="hljs-keyword">const</span> { is, empty } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'o'</span>);</code></pre>
<h4 id="browser">Browser</h4>
<h5 id="es6">ES6</h5>
<a href="#browser" id="browser" style="color: inherit; text-decoration: none;">
<h4>Browser</h4>
</a>
<a href="#es6" id="es6" style="color: inherit; text-decoration: none;">
<h5>ES6</h5>
</a>
<pre><code class="language-html"><span class="hljs-comment">&lt;!-- Script tag --&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span>
<span class="hljs-attr">type</span>=<span class="hljs-string">"module"</span>
Expand All @@ -97,12 +115,16 @@ <h5 id="es6">ES6</h5>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span>&gt;</span><span class="actionscript">
<span class="hljs-meta"><span class="hljs-meta-keyword">import</span> './o.min.js';</span>
</span></span></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<h5 id="cdn-script">CDN/Script</h5>
<a href="#cdnscript" id="cdnscript" style="color: inherit; text-decoration: none;">
<h5>CDN/Script</h5>
</a>
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span>
<span class="hljs-attr">type</span>=<span class="hljs-string">"application/javascript"</span>
<span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/o@2.0.0/dist/o.min.js"</span>
/&gt;</span></code></pre>
<h3 id="example-usage">Example usage</h3>
<a href="#example-usage" id="example-usage" style="color: inherit; text-decoration: none;">
<h3>Example usage</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> a = {
<span class="hljs-attr">a</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">b</span>: <span class="hljs-number">2</span>,
Expand All @@ -121,9 +143,13 @@ <h3 id="example-usage">Example usage</h3>
<span class="hljs-keyword">const</span> b = <span class="hljs-keyword">set</span>(a, 'f', 5);
<span class="hljs-keyword">get</span>(b, 'f'); // =&gt; 5</code></pre>
<p>For more examples and a list of all functions view the <a href="https://o.hammy2899.dev">documentation page</a>.</p>
<h3 id="documentation">Documentation</h3>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h3>Documentation</h3>
</a>
<p>You can view the <a href="https://o.hammy2899.dev">documentation here</a>, docs are generated by <a href="https://typedoc.org">TypeDoc</a>.</p>
<h3 id="contributing">Contributing</h3>
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
<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
with no errors and if any tests fail or any linting issues are raised please fix them accordingly.</p>
Expand Down Expand Up @@ -249,6 +275,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -297,7 +324,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 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/7e01be0/src/types.ts#L6">types.ts:6</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L6">types.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -212,6 +212,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -260,7 +261,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.eachcallback.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3 class="tsd-before-signature">Callable</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/7e01be0/src/types.ts#L13">types.ts:13</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L13">types.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -209,6 +209,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -257,7 +258,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.eachoptions.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/7e01be0/src/types.ts#L10">types.ts:10</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L10">types.ts:10</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -212,6 +212,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -260,7 +261,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.everycallback.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3 class="tsd-before-signature">Callable</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/7e01be0/src/types.ts#L21">types.ts:21</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L21">types.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -209,6 +209,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -257,7 +258,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.everyoptions.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/7e01be0/src/types.ts#L18">types.ts:18</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L18">types.ts:18</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -212,6 +212,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -260,7 +261,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.filtercallback.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3 class="tsd-before-signature">Callable</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/7e01be0/src/types.ts#L29">types.ts:29</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L29">types.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -209,6 +209,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -257,7 +258,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
5 changes: 3 additions & 2 deletions docs/interfaces/_types_.filteroptions.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/7e01be0/src/types.ts#L26">types.ts:26</a></li>
<li>Defined in <a href="https://github.com/hammy2899/o/blob/fad38e2/src/types.ts#L26">types.ts:26</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -212,6 +212,7 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
Expand Down Expand Up @@ -260,7 +261,7 @@ <h2>Legend</h2>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
Expand Down
Loading

0 comments on commit 264baf1

Please sign in to comment.