docs: update jsdoc reference home

ecomplus · Apr 29, 2019 · ad7aa63 · ad7aa63
1 parent 848c6cd
commit ad7aa63
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 14 deletions.
diff --git a/docs/EcomCart.html b/docs/EcomCart.html
@@ -1014,7 +1014,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -49,7 +49,13 @@ <h3> </h3>
 <p>Simple vanilla JS library to handle shopping cart with
 common methods following
 <a href="https://developers.e-com.plus/docs/api/#/store/carts/carts">E-Com Plus cart object model</a></p>
-<h2>Documentation</h2><p><a href="https://developers.e-com.plus/shopping-cart/EcomCart.html"><code>EcomCart</code> object and methods</a></p></article>
+<h2>Getting started</h2><p><strong>This library is available for browser only</strong></p>
+<p>Include minified bundle via CDN:</p>
+<pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/@ecomplus/shopping-cart@0/dist/shopping-cart.min.js&quot;>&lt;/script></code></pre><h3>With bundlers</h3><p>If using <code>webpack</code> or <code>browserify</code> (or relateds),
+you can also install the
+<a href="https://www.npmjs.com/package/@ecomplus/shopping-cart">npm package</a>:</p>
+<pre class="prettyprint source lang-bash"><code>npm install --save @ecomplus/shopping-cart</code></pre><p>And import the bundle file:</p>
+<pre class="prettyprint source lang-js"><code>import '@ecomplus/shopping-cart'</code></pre><h2>Documentation</h2><p><a href="https://developers.e-com.plus/shopping-cart/EcomCart.html"><code>EcomCart</code> object and methods</a></p></article>
     </section>
 
 
@@ -66,7 +72,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -108,11 +108,15 @@ <h1 class="page-title">Source: index.js</h1>
     }
 
     // fix item quantity if needed
-    if (item.min_quantity &amp;&amp; item.quantity &lt; item.min_quantity) {
-      item.quantity = item.min_quantity
-    } else if (item.max_quantity &amp;&amp; item.quantity > item.max_quantity) {
-      item.quantity = item.max_quantity
+    // use minimun quantity 1 by default
+    var min = item.min_quantity || 1
+    var max = item.max_quantity
+    if (typeof item.quantity !== 'number' || isNaN(item.quantity) || item.quantity &lt; min) {
+      item.quantity = min
+    } else if (max &amp;&amp; item.quantity > max) {
+      item.quantity = max
     }
+    // save the cart object again and return current item ID
     EcomCart.saveCart()
     return item._id
   }
@@ -151,7 +155,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/methods_addItem.js.html b/docs/methods_addItem.js.html
@@ -86,7 +86,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/methods_clearCart.js.html b/docs/methods_clearCart.js.html
@@ -57,7 +57,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/methods_increaseItemQnt.js.html b/docs/methods_increaseItemQnt.js.html
@@ -69,7 +69,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/methods_removeItem.js.html b/docs/methods_removeItem.js.html
@@ -67,7 +67,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/module-@ecomplus_shopping-cart.html b/docs/module-@ecomplus_shopping-cart.html
@@ -87,7 +87,7 @@ <h1 class="page-title">Module: @ecomplus/shopping-cart</h1>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line92">line 92</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line96">line 96</a>
     </li></ul></dd>
 
 
@@ -176,7 +176,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@e
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 20 2019 00:56:24 GMT-0300 (Brasilia Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Apr 29 2019 15:52:41 GMT-0300 (Brasilia Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>