Skip to content

Commit 10fcdbd

Browse files
helderbertohelderberto
authored
Merge pull request #22 from codevor/develop
docs: generated new docs
2 parents 72d4ff7 + def2f81 commit 10fcdbd

18 files changed

+36
-36
lines changed

‎docs/index.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,18 @@ <h3>js-http-status 0.1.0</h3>
6363
<p>A simple way to catch HTTP statuses with JavaScript.</p>
6464
</blockquote>
6565
<h2>Installation</h2>
66-
<!-- js-http-status is available on npm/yarn:
67-
68-
```bash
69-
$ npm install js-http-status --save
66+
<p>js-http-status is available on npm/yarn:</p>
67+
<pre class="prettyprint source lang-bash"><code>$ npm install js-http-status --save
7068
$ yarn add js-http-status
71-
``` -->
72-
<blockquote>
73-
<p>Under construction</p>
74-
</blockquote>
69+
</code></pre>
7570
<h2>Usage</h2>
7671
<p>With ES6/import</p>
77-
<pre class="prettyprint source lang-js"><code>import { findHttpStatus, isCreated, isOk } from 'js-http-status';
72+
<pre class="prettyprint source lang-js"><code>import {
73+
findStatusByCode,
74+
findStatusByKey,
75+
isCreated,
76+
isOk
77+
} from 'js-http-status';
7878

7979
findStatusByCode(200);
8080
// => { code: 200, key: 'OK', message: 'OK', category: 'SUCCESS' }
@@ -111,7 +111,7 @@ <h2>License</h2>
111111
<br class="clear">
112112

113113
<footer>
114-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
114+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
115115
</footer>
116116

117117
<script>prettyPrint();</script>

‎docs/is-created.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-created.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/is-moved-permanently.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-moved-permanently.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/is-ok.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-ok.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/is-unauthorized.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-unauthorized.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/index.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,18 @@ <h3>js-http-status 0.1.0</h3>
6363
<p>A simple way to catch HTTP statuses with JavaScript.</p>
6464
</blockquote>
6565
<h2>Installation</h2>
66-
<!-- js-http-status is available on npm/yarn:
67-
68-
```bash
69-
$ npm install js-http-status --save
66+
<p>js-http-status is available on npm/yarn:</p>
67+
<pre class="prettyprint source lang-bash"><code>$ npm install js-http-status --save
7068
$ yarn add js-http-status
71-
``` -->
72-
<blockquote>
73-
<p>Under construction</p>
74-
</blockquote>
69+
</code></pre>
7570
<h2>Usage</h2>
7671
<p>With ES6/import</p>
77-
<pre class="prettyprint source lang-js"><code>import { findHttpStatus, isCreated, isOk } from 'js-http-status';
72+
<pre class="prettyprint source lang-js"><code>import {
73+
findStatusByCode,
74+
findStatusByKey,
75+
isCreated,
76+
isOk
77+
} from 'js-http-status';
7878

7979
findStatusByCode(200);
8080
// => { code: 200, key: 'OK', message: 'OK', category: 'SUCCESS' }
@@ -111,7 +111,7 @@ <h2>License</h2>
111111
<br class="clear">
112112

113113
<footer>
114-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
114+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
115115
</footer>
116116

117117
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/is-created.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-created.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/is-moved-permanently.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-moved-permanently.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/is-ok.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-ok.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/is-unauthorized.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h1 class="page-title">is-unauthorized.js</h1>
7272
<br class="clear">
7373

7474
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
75+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7676
</footer>
7777

7878
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/module-isCreated.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/module-isMovedPermanently.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/module-isOk.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/js-http-status/0.1.0/module-isUnauthorized.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/module-isCreated.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/module-isMovedPermanently.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/module-isOk.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

‎docs/module-isUnauthorized.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
269269
<br class="clear">
270270

271271
<footer>
272-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 22:52:48 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
272+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
273273
</footer>
274274

275275
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)