chore(*): Review tests, webpack and update package name

liqueurdetoile · Feb 18, 2018 · 1a81c38 · 1a81c38
1 parent 9e9f8b7
commit 1a81c38
Show file tree

Hide file tree

Showing 12 changed files with 1,546 additions and 39 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -13,8 +13,8 @@
 
 <dl>
 <dt><a href="#dottedKey">dottedKey</a> : <code>String</code></dt>
-<dd><p>A dotted key is useful to quicly access sub-properties of
- the data stored into the ObjectArray as if it was still a
+<dd><p>A dotted key is useful to quickly access a subset of data
+ stored into the ObjectArray as if it was still a
  vanilla <tt>Object</tt>.</p>
 </dd>
 </dl>
@@ -37,7 +37,7 @@ The ObjectArray class implements array-like properties and methods to
 **Since**: 1.0.0  
 **Version**: 1.0.0  
 **Author**: Liqueur de Toile <contact@liqueurdetoile.com>  
-**License**: Apache-2.0 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)  
+**License**: MIT [https://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/mit/)  
 
 * [ObjectArray](#ObjectArray)
     * [new ObjectArray(data)](#new_ObjectArray_new)
@@ -60,7 +60,7 @@ The ObjectArray class implements array-like properties and methods to
 <a name="new_ObjectArray_new"></a>
 
 ### new ObjectArray(data)
-The constructor is pretty simple. It can be provided with an existent object
+The constructor is straight-forward. It can be provided with an existent object
 
 **Returns**: [<code>ObjectArray</code>](#ObjectArray) - ObjectArray object  
 
@@ -302,8 +302,8 @@ Returns a string suitable for a <tt>form-url-encoded</tt> query string
 <a name="dottedKey"></a>
 
 ## dottedKey : <code>String</code>
-A dotted key is useful to quicly access sub-properties of
- the data stored into the ObjectArray as if it was still a
+A dotted key is useful to quickly access a subset of data
+ stored into the ObjectArray as if it was still a
  vanilla <tt>Object</tt>.
 
 **Kind**: global typedef  

diff --git a/docs/html/ObjectArray.html b/docs/html/ObjectArray.html
@@ -111,7 +111,7 @@ <h4 class="name" id="ObjectArray"><span class="type-signature"></span>new Object
 
 
     <dt class="tag-license">License:</dt>
-    <dd class="tag-license"><ul class="dummy"><li>Apache-2.0 <a href="https://www.apache.org/licenses/LICENSE-2.0">https://www.apache.org/licenses/LICENSE-2.0</a></li></ul></dd>
+    <dd class="tag-license"><ul class="dummy"><li>MIT <a href="https://choosealicense.com/licenses/mit/">https://choosealicense.com/licenses/mit/</a></li></ul></dd>
 
 
 
@@ -137,7 +137,7 @@ <h4 class="name" id="ObjectArray"><span class="type-signature"></span>new Object
 
 
 <div class="description">
-    <p>The constructor is pretty simple. It can be provided with an existent object</p>
+    <p>The constructor is straight-forward. It can be provided with an existent object</p>
 </div>
 
 
@@ -3022,7 +3022,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 14:53:30 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 23:33:38 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/html/global.html b/docs/html/global.html
@@ -165,8 +165,8 @@ <h4 class="name" id="dottedKey">dottedKey</h4>
 
 
 <div class="description">
-    <p>A dotted key is useful to quicly access sub-properties of
- the data stored into the ObjectArray as if it was still a
+    <p>A dotted key is useful to quickly access a subset of data
+ stored into the ObjectArray as if it was still a
  vanilla <tt>Object</tt>.</p>
 </div>
 
@@ -220,7 +220,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 14:53:30 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 23:33:38 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -107,7 +107,7 @@ <h2>
 
 
     <dt class="tag-license">License:</dt>
-    <dd class="tag-license"><ul class="dummy"><li>Apache-2.0 <a href="https://www.apache.org/licenses/LICENSE-2.0">https://www.apache.org/licenses/LICENSE-2.0</a></li></ul></dd>
+    <dd class="tag-license"><ul class="dummy"><li>MIT <a href="https://choosealicense.com/licenses/mit/">https://choosealicense.com/licenses/mit/</a></li></ul></dd>
 
 
 
@@ -168,7 +168,7 @@ <h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 14:53:30 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 23:33:38 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/html/index.js.html b/docs/html/index.js.html
@@ -40,7 +40,7 @@ <h1 class="page-title">index.js</h1>
             <pre class="prettyprint source linenums"><code>/**
 *  @file ObjectArray class declaration
 *  @author  Liqueur de Toile &lt;contact@liqueurdetoile.com>
-*  @license Apache-2.0 {@link https://www.apache.org/licenses/LICENSE-2.0}
+*  @license MIT {@link https://choosealicense.com/licenses/mit/}
 *  @see [Github]{@link https://github.com/liqueurdetoile/objectarray}
 *  @see [Author website]{@link https://liqueurdetoile.com}
 */
@@ -57,18 +57,18 @@ <h1 class="page-title">index.js</h1>
 *  @since 1.0.0
 *  @version 1.0.0
 *  @author Liqueur de Toile &lt;contact@liqueurdetoile.com>
-*  @license Apache-2.0 {@link https://www.apache.org/licenses/LICENSE-2.0}
+*  @license MIT {@link https://choosealicense.com/licenses/mit/}
 *  @see [Github]{@link https://github.com/liqueurdetoile/objectarray}
 *  @see [Author website]{@link https://liqueurdetoile.com}
 *
 *  @param   {Object}    data  Initial data to push into the ObjectArray
 *
 *  @returns {ObjectArray} ObjectArray object
 *  @description
-*  The constructor is pretty simple. It can be provided with an existent object
+*  The constructor is straight-forward. It can be provided with an existent object
 */
 
-class ObjectArray {
+export default class ObjectArray {
   constructor(data = {}) {
     /**
     *  The inner data object
@@ -404,14 +404,14 @@ <h1 class="page-title">index.js</h1>
   }
 }
 
-export default ObjectArray;
+if(window) window.ObjectArray = ObjectArray;
 
 /**
 *  @typedef dottedKey
 *  @type String
 *  @description
-*  A dotted key is useful to quicly access sub-properties of
-*  the data stored into the ObjectArray as if it was still a
+*  A dotted key is useful to quickly access a subset of data
+*  stored into the ObjectArray as if it was still a
 *  vanilla &lt;tt>Object&lt;/tt>.
 *  @example
 *  // Create an ObjectArray with subdata
@@ -440,7 +440,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 14:53:30 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 23:33:38 GMT+0100 (Paris, Madrid) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>