WIP documentation

nitro404 · Mar 23, 2020 · 5694d15 · 5694d15
1 parent 82d8fc4
commit 5694d15
Show file tree

Hide file tree

Showing 40 changed files with 22,820 additions and 122 deletions.
diff --git a/.npmignore b/.npmignore
@@ -11,5 +11,4 @@ package-lock.json
 yarn.lock
 gulpfile.js
 LICENSE
-README.md
 CHANGELOG.md
diff --git a/README.md b/README.md
@@ -10,9 +10,13 @@
 [![Contributors][contributors-image]][contributors-url]
 [![Pull Requests Welcome][pull-requests-image]][pull-requests-url]
 
-A collection of useful helper functions.
+A collection of useful JavaScript helper functions.
 
-## Client-Side Usage
+## Documentation
+
+Complete API documentation is available [here][documentation-url].
+
+## Web Usage
 
 ```html
 <script src="extra-utilities.js"></script>
@@ -22,12 +26,12 @@ A collection of useful helper functions.
 </script>
 ```
 
-## Server-Side Usage
+## Node.js Usage
 
 ```javascript
 const utilities = require("extra-utilities");
 
-utilities.isBoolean(false); // => true
+utilities.isValidNumber(NaN); // => false
 ```
 
 ## Installation
@@ -43,11 +47,21 @@ To build the distribution files for this module:
 ```bash
 npm run build
 ```
-or
+
+## Running Unit Tests
+
+To run the unit test suite for this module:
+```bash
+npm run test
+```
+
+## Generating Documentation
 ```bash
-gulp build
+npm run docs
 ```
 
+[documentation-url]: https://nitro404.github.io/extra-utilities/module-utilities.html
+
 [npm-url]: https://www.npmjs.com/package/extra-utilities
 [npm-version-image]: https://img.shields.io/npm/v/extra-utilities.svg
 [npm-downloads-image]: http://img.shields.io/npm/dm/extra-utilities.svg

diff --git a/dist/extra-utilities.min.js b/dist/extra-utilities.min.js
diff --git a/dist/extra-utilities.min.js.map b/dist/extra-utilities.min.js.map
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/extra-utilities.js.html b/docs/extra-utilities.js.html
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.eot b/docs/fonts/Montserrat/Montserrat-Bold.eot
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.ttf b/docs/fonts/Montserrat/Montserrat-Bold.ttf
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff b/docs/fonts/Montserrat/Montserrat-Bold.woff
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff2 b/docs/fonts/Montserrat/Montserrat-Bold.woff2
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.eot b/docs/fonts/Montserrat/Montserrat-Regular.eot
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.ttf b/docs/fonts/Montserrat/Montserrat-Regular.ttf
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff b/docs/fonts/Montserrat/Montserrat-Regular.woff
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff2 b/docs/fonts/Montserrat/Montserrat-Regular.woff2
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+
+    <meta charset="utf-8">
+    <title>Home - Documentation</title>
+
+
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+
+<label for="nav-trigger" class="overlay"></label>
+
+<nav >
+
+    <input type="text" id="nav-search" placeholder="Search" />
+
+    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/nitro404/extra-utilities" >Repository</a></h2><h3>Modules</h3><ul><li><a href="module-utilities.html">utilities</a><ul class='methods'><li data-type='method'><a href="module-utilities.html#.addLeadingZeroes">addLeadingZeroes</a></li><li data-type='method'><a href="module-utilities.html#.appendSlash">appendSlash</a></li><li data-type='method'><a href="module-utilities.html#.clone">clone</a></li><li data-type='method'><a href="module-utilities.html#.compareCasePercentage">compareCasePercentage</a></li><li data-type='method'><a href="module-utilities.html#.compareDates">compareDates</a></li><li data-type='method'><a href="module-utilities.html#.compareVersions">compareVersions</a></li><li data-type='method'><a href="module-utilities.html#.createError">createError</a></li><li data-type='method'><a href="module-utilities.html#.createQueryString">createQueryString</a></li><li data-type='method'><a href="module-utilities.html#.createRange">createRange</a></li><li data-type='method'><a href="module-utilities.html#.disabledElements">disabledElements</a></li><li data-type='method'><a href="module-utilities.html#.elementsWithAttribute">elementsWithAttribute</a></li><li data-type='method'><a href="module-utilities.html#.elementsWithoutAttribute">elementsWithoutAttribute</a></li><li data-type='method'><a href="module-utilities.html#.enabledElements">enabledElements</a></li><li data-type='method'><a href="module-utilities.html#.equalsIgnoreCase">equalsIgnoreCase</a></li><li data-type='method'><a href="module-utilities.html#.fileHasExtension">fileHasExtension</a></li><li data-type='method'><a href="module-utilities.html#.formatObject">formatObject</a></li><li data-type='method'><a href="module-utilities.html#.formatStringList">formatStringList</a></li><li data-type='method'><a href="module-utilities.html#.formatValue">formatValue</a></li><li data-type='method'><a href="module-utilities.html#.futureMonths">futureMonths</a></li><li data-type='method'><a href="module-utilities.html#.generateVersions">generateVersions</a></li><li data-type='method'><a href="module-utilities.html#.getFileExtension">getFileExtension</a></li><li data-type='method'><a href="module-utilities.html#.getFileName">getFileName</a></li><li data-type='method'><a href="module-utilities.html#.getFileNameNoExtension">getFileNameNoExtension</a></li><li data-type='method'><a href="module-utilities.html#.getFilePath">getFilePath</a></li><li data-type='method'><a href="module-utilities.html#.hiddenElements">hiddenElements</a></li><li data-type='method'><a href="module-utilities.html#.indentText">indentText</a></li><li data-type='method'><a href="module-utilities.html#.isBoolean">isBoolean</a></li><li data-type='method'><a href="module-utilities.html#.isComment">isComment</a></li><li data-type='method'><a href="module-utilities.html#.isDate">isDate</a></li><li data-type='method'><a href="module-utilities.html#.isDisabled">isDisabled</a></li><li data-type='method'><a href="module-utilities.html#.isEmptyArray">isEmptyArray</a></li><li data-type='method'><a href="module-utilities.html#.isEmptyObject">isEmptyObject</a></li><li data-type='method'><a href="module-utilities.html#.isEmptyString">isEmptyString</a></li><li data-type='method'><a href="module-utilities.html#.isEnabled">isEnabled</a></li><li data-type='method'><a href="module-utilities.html#.isError">isError</a></li><li data-type='method'><a href="module-utilities.html#.isFunction">isFunction</a></li><li data-type='method'><a href="module-utilities.html#.isHidden">isHidden</a></li><li data-type='method'><a href="module-utilities.html#.isInvalid">isInvalid</a></li><li data-type='method'><a href="module-utilities.html#.isInvalidNumber">isInvalidNumber</a></li><li data-type='method'><a href="module-utilities.html#.isNonEmptyArray">isNonEmptyArray</a></li><li data-type='method'><a href="module-utilities.html#.isNonEmptyObject">isNonEmptyObject</a></li><li data-type='method'><a href="module-utilities.html#.isNonEmptyString">isNonEmptyString</a></li><li data-type='method'><a href="module-utilities.html#.isObject">isObject</a></li><li data-type='method'><a href="module-utilities.html#.isObjectStrict">isObjectStrict</a></li><li data-type='method'><a href="module-utilities.html#.isRegularExpression">isRegularExpression</a></li><li data-type='method'><a href="module-utilities.html#.isValid">isValid</a></li><li data-type='method'><a href="module-utilities.html#.isValidNumber">isValidNumber</a></li><li data-type='method'><a href="module-utilities.html#.isVisible">isVisible</a></li><li data-type='method'><a href="module-utilities.html#.joinPaths">joinPaths</a></li><li data-type='method'><a href="module-utilities.html#.leftShift">leftShift</a></li><li data-type='method'><a href="module-utilities.html#.matchAttribute">matchAttribute</a></li><li data-type='method'><a href="module-utilities.html#.merge">merge</a></li><li data-type='method'><a href="module-utilities.html#.parseBoolean">parseBoolean</a></li><li data-type='method'><a href="module-utilities.html#.parseDate">parseDate</a></li><li data-type='method'><a href="module-utilities.html#.parseEmail">parseEmail</a></li><li data-type='method'><a href="module-utilities.html#.parseEmailDomain">parseEmailDomain</a></li><li data-type='method'><a href="module-utilities.html#.parseFloatingPointNumber">parseFloatingPointNumber</a></li><li data-type='method'><a href="module-utilities.html#.parseInteger">parseInteger</a></li><li data-type='method'><a href="module-utilities.html#.parseRegularExpression">parseRegularExpression</a></li><li data-type='method'><a href="module-utilities.html#.parseStringList">parseStringList</a></li><li data-type='method'><a href="module-utilities.html#.parseTime">parseTime</a></li><li data-type='method'><a href="module-utilities.html#.parseVersion">parseVersion</a></li><li data-type='method'><a href="module-utilities.html#.parseYouTubeLink">parseYouTubeLink</a></li><li data-type='method'><a href="module-utilities.html#.prependSlash">prependSlash</a></li><li data-type='method'><a href="module-utilities.html#.replaceNonBreakingSpaces">replaceNonBreakingSpaces</a></li><li data-type='method'><a href="module-utilities.html#.reverseFileExtension">reverseFileExtension</a></li><li data-type='method'><a href="module-utilities.html#.reverseString">reverseString</a></li><li data-type='method'><a href="module-utilities.html#.rightShift">rightShift</a></li><li data-type='method'><a href="module-utilities.html#.toString">toString</a></li><li data-type='method'><a href="module-utilities.html#.trimLeadingZeroes">trimLeadingZeroes</a></li><li data-type='method'><a href="module-utilities.html#.trimNullTerminatedString">trimNullTerminatedString</a></li><li data-type='method'><a href="module-utilities.html#.trimString">trimString</a></li><li data-type='method'><a href="module-utilities.html#.trimTrailingNewlines">trimTrailingNewlines</a></li><li data-type='method'><a href="module-utilities.html#.trimWhitespace">trimWhitespace</a></li><li data-type='method'><a href="module-utilities.html#.truncateFileName">truncateFileName</a></li><li data-type='method'><a href="module-utilities.html#.visibleElements">visibleElements</a></li></ul></li></ul>
+</nav>
+
+<div id="main">
+
+
+
+
+
+
+
+
+
+    <section class="package">
+        <h3> </h3>		
+    </section>
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <section class="readme usertext">
+        <article><h1>Extra Utilities</h1>
+<p><a href="https://www.npmjs.com/package/extra-utilities"><img src="https://img.shields.io/npm/v/extra-utilities.svg" alt="NPM version"></a>
+<a href="https://travis-ci.org/nitro404/extra-utilities"><img src="https://travis-ci.org/nitro404/extra-utilities.svg?branch=master" alt="Build Status"></a>
+<a href="https://coveralls.io/github/nitro404/extra-utilities?branch=master"><img src="https://coveralls.io/repos/github/nitro404/extra-utilities/badge.svg?branch=master" alt="Coverage Status"></a>
+<a href="https://snyk.io/test/github/nitro404/extra-utilities?targetFile=package.json"><img src="https://snyk.io/test/github/nitro404/extra-utilities/badge.svg?targetFile=package.json" alt="Known Vulnerabilities"></a>
+<a href="https://david-dm.org/nitro404/extra-utilities"><img src="https://img.shields.io/david/nitro404/extra-utilities.svg" alt="Dependencies"></a>
+<a href="https://www.npmjs.com/package/extra-utilities"><img src="http://img.shields.io/npm/dm/extra-utilities.svg" alt="Downloads"></a>
+<a href="https://packagephobia.now.sh/result?p=extra-utilities"><img src="https://badgen.net/packagephobia/install/extra-utilities" alt="Install Size"></a>
+<a href="https://github.com/nitro404/extra-utilities/graphs/contributors"><img src="https://img.shields.io/github/contributors/nitro404/extra-utilities.svg" alt="Contributors"></a>
+<a href="https://github.com/nitro404/extra-utilities/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="Pull Requests Welcome"></a></p>
+<p>A collection of useful JavaScript helper functions.</p>
+<h2>Documentation</h2>
+<p>Complete API documentation is available <a href="https://nitro404.github.io/extra-utilities/module-utilities.html">here</a>.</p>
+<h2>Web Usage</h2>
+<pre class="prettyprint source lang-html"><code>&lt;script src=&quot;extra-utilities.js&quot;>&lt;/script>
+
+&lt;script type=&quot;text/javascript&quot;>
+	utilities.isBoolean(false); // => true
+&lt;/script>
+</code></pre>
+<h2>Node.js Usage</h2>
+<pre class="prettyprint source lang-javascript"><code>const utilities = require(&quot;extra-utilities&quot;);
+
+utilities.isValidNumber(NaN); // => false
+</code></pre>
+<h2>Installation</h2>
+<p>To install this module:</p>
+<pre class="prettyprint source lang-bash"><code>npm install extra-utilities
+</code></pre>
+<h2>Building</h2>
+<p>To build the distribution files for this module:</p>
+<pre class="prettyprint source lang-bash"><code>npm run build
+</code></pre>
+<h2>Running Unit Tests</h2>
+<p>To run the unit test suite for this module:</p>
+<pre class="prettyprint source lang-bash"><code>npm run test
+</code></pre>
+<h2>Generating Documentation</h2>
+<pre class="prettyprint source lang-bash"><code>npm run docs
+</code></pre></article>
+    </section>
+
+
+
+
+
+
+
+
+</div>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Mar 22 2020 22:57:48 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+
+<script src="scripts/search.js" defer></script>
+
+
+
+</body>
+</html>