Skip to content

Commit 9844f61

Browse files
committed
docs(generate): update jsdoc/docdash generated documentation
1 parent 5aef2ba commit 9844f61

31 files changed

+846
-100
lines changed

docs/EcomSearch.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
<nav >
2929

30-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EcomSearch.html">EcomSearch</a><ul class='methods'><li data-type='method'><a href="EcomSearch.html#fetch">fetch</a></li><li data-type='method'><a href="EcomSearch.html#getBrands">getBrands</a></li><li data-type='method'><a href="EcomSearch.html#getCategories">getCategories</a></li><li data-type='method'><a href="EcomSearch.html#getItems">getItems</a></li><li data-type='method'><a href="EcomSearch.html#getPriceRange">getPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#getSpecs">getSpecs</a></li><li data-type='method'><a href="EcomSearch.html#getTermSuggestions">getTermSuggestions</a></li><li data-type='method'><a href="EcomSearch.html#getTotalCount">getTotalCount</a></li><li data-type='method'><a href="EcomSearch.html#mergeFilter">mergeFilter</a></li><li data-type='method'><a href="EcomSearch.html#removeFilter">removeFilter</a></li><li data-type='method'><a href="EcomSearch.html#reset">reset</a></li><li data-type='method'><a href="EcomSearch.html#setBrandIds">setBrandIds</a></li><li data-type='method'><a href="EcomSearch.html#setBrandNames">setBrandNames</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryIds">setCategoryIds</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryNames">setCategoryNames</a></li><li data-type='method'><a href="EcomSearch.html#setPageNumber">setPageNumber</a></li><li data-type='method'><a href="EcomSearch.html#setPageSize">setPageSize</a></li><li data-type='method'><a href="EcomSearch.html#setPriceRange">setPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#setProductIds">setProductIds</a></li><li data-type='method'><a href="EcomSearch.html#setSearchTerm">setSearchTerm</a></li><li data-type='method'><a href="EcomSearch.html#setSkus">setSkus</a></li><li data-type='method'><a href="EcomSearch.html#setSortOrder">setSortOrder</a></li><li data-type='method'><a href="EcomSearch.html#setSpec">setSpec</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-@ecomplus_search-engine.html">@ecomplus/search-engine</a></li></ul><h3><a href="global.html">Global</a></h3>
30+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EcomSearch.html">EcomSearch</a><ul class='methods'><li data-type='method'><a href="EcomSearch.html#fetch">fetch</a></li><li data-type='method'><a href="EcomSearch.html#getBrands">getBrands</a></li><li data-type='method'><a href="EcomSearch.html#getCategories">getCategories</a></li><li data-type='method'><a href="EcomSearch.html#getItems">getItems</a></li><li data-type='method'><a href="EcomSearch.html#getPriceRange">getPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#getSpecs">getSpecs</a></li><li data-type='method'><a href="EcomSearch.html#getTermSuggestions">getTermSuggestions</a></li><li data-type='method'><a href="EcomSearch.html#getTotalCount">getTotalCount</a></li><li data-type='method'><a href="EcomSearch.html#mergeFilter">mergeFilter</a></li><li data-type='method'><a href="EcomSearch.html#removeFilter">removeFilter</a></li><li data-type='method'><a href="EcomSearch.html#reset">reset</a></li><li data-type='method'><a href="EcomSearch.html#setBrandIds">setBrandIds</a></li><li data-type='method'><a href="EcomSearch.html#setBrandNames">setBrandNames</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryIds">setCategoryIds</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryNames">setCategoryNames</a></li><li data-type='method'><a href="EcomSearch.html#setPageNumber">setPageNumber</a></li><li data-type='method'><a href="EcomSearch.html#setPageSize">setPageSize</a></li><li data-type='method'><a href="EcomSearch.html#setPriceRange">setPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#setProductIds">setProductIds</a></li><li data-type='method'><a href="EcomSearch.html#setSearchTerm">setSearchTerm</a></li><li data-type='method'><a href="EcomSearch.html#setSkus">setSkus</a></li><li data-type='method'><a href="EcomSearch.html#setSortOrder">setSortOrder</a></li><li data-type='method'><a href="EcomSearch.html#setSpec">setSpec</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-@ecomplus_search-engine.html">@ecomplus/search-engine</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addGlobalFilter">addGlobalFilter</a></li><li><a href="global.html#setSalesChannel">setSalesChannel</a></li><li><a href="global.html#setWarehouse">setWarehouse</a></li></ul>
3131
</nav>
3232

3333
<div id="main">
@@ -71,7 +71,7 @@ <h4 class="name" id="EcomSearch"><span class="type-signature"></span>new EcomSea
7171

7272
<dt class="tag-source">Source:</dt>
7373
<dd class="tag-source"><ul class="dummy"><li>
74-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line150">line 150</a>
74+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line144">line 144</a>
7575
</li></ul></dd>
7676

7777

@@ -332,7 +332,7 @@ <h4 class="name" id="dsl"><span class="type-signature"></span>dsl<span class="ty
332332

333333
<dt class="tag-source">Source:</dt>
334334
<dd class="tag-source"><ul class="dummy"><li>
335-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
335+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line87">line 87</a>
336336
</li></ul></dd>
337337

338338

@@ -411,7 +411,7 @@ <h4 class="name" id="history"><span class="type-signature"></span>history<span c
411411

412412
<dt class="tag-source">Source:</dt>
413413
<dd class="tag-source"><ul class="dummy"><li>
414-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
414+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line80">line 80</a>
415415
</li></ul></dd>
416416

417417

@@ -484,7 +484,7 @@ <h4 class="name" id="localStorage"><span class="type-signature"></span>localStor
484484

485485
<dt class="tag-source">Source:</dt>
486486
<dd class="tag-source"><ul class="dummy"><li>
487-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line79">line 79</a>
487+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line73">line 73</a>
488488
</li></ul></dd>
489489

490490

@@ -557,7 +557,7 @@ <h4 class="name" id="result"><span class="type-signature"></span>result<span cla
557557

558558
<dt class="tag-source">Source:</dt>
559559
<dd class="tag-source"><ul class="dummy"><li>
560-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line106">line 106</a>
560+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line100">line 100</a>
561561
</li></ul></dd>
562562

563563

@@ -634,7 +634,7 @@ <h4 class="name" id="storageKey"><span class="type-signature"></span>storageKey<
634634

635635
<dt class="tag-source">Source:</dt>
636636
<dd class="tag-source"><ul class="dummy"><li>
637-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line71">line 71</a>
637+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line65">line 65</a>
638638
</li></ul></dd>
639639

640640

@@ -711,7 +711,7 @@ <h4 class="name" id="storeId"><span class="type-signature"></span>storeId<span c
711711

712712
<dt class="tag-source">Source:</dt>
713713
<dd class="tag-source"><ul class="dummy"><li>
714-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
714+
<a href="constructor.js.html">constructor.js</a>, <a href="constructor.js.html#line58">line 58</a>
715715
</li></ul></dd>
716716

717717

@@ -794,7 +794,7 @@ <h4 class="name" id="fetch"><span class="type-signature"></span>fetch<span class
794794

795795
<dt class="tag-source">Source:</dt>
796796
<dd class="tag-source"><ul class="dummy"><li>
797-
<a href="methods_fetch.js.html">methods/fetch.js</a>, <a href="methods_fetch.js.html#line80">line 80</a>
797+
<a href="methods_fetch.js.html">methods/fetch.js</a>, <a href="methods_fetch.js.html#line93">line 93</a>
798798
</li></ul></dd>
799799

800800

@@ -4624,7 +4624,7 @@ <h4 class="name" id="setSortOrder"><span class="type-signature"></span>setSortOr
46244624

46254625
<dt class="tag-source">Source:</dt>
46264626
<dd class="tag-source"><ul class="dummy"><li>
4627-
<a href="methods_set-sort-order.js.html">methods/set-sort-order.js</a>, <a href="methods_set-sort-order.js.html#line92">line 92</a>
4627+
<a href="methods_set-sort-order.js.html">methods/set-sort-order.js</a>, <a href="methods_set-sort-order.js.html#line84">line 84</a>
46284628
</li></ul></dd>
46294629

46304630

@@ -5026,7 +5026,7 @@ <h5>Returns:</h5>
50265026
<br class="clear">
50275027

50285028
<footer>
5029-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Nov 26 2020 20:36:12 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5029+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 31 2021 21:14:40 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
50305030
</footer>
50315031

50325032
<script>prettyPrint();</script>
Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>index.js - Documentation</title>
6+
<title>constructor.js - Documentation</title>
77

88

99
<script src="scripts/prettify/prettify.js"></script>
@@ -27,12 +27,12 @@
2727

2828
<nav >
2929

30-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EcomSearch.html">EcomSearch</a><ul class='methods'><li data-type='method'><a href="EcomSearch.html#fetch">fetch</a></li><li data-type='method'><a href="EcomSearch.html#getBrands">getBrands</a></li><li data-type='method'><a href="EcomSearch.html#getCategories">getCategories</a></li><li data-type='method'><a href="EcomSearch.html#getItems">getItems</a></li><li data-type='method'><a href="EcomSearch.html#getPriceRange">getPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#getSpecs">getSpecs</a></li><li data-type='method'><a href="EcomSearch.html#getTermSuggestions">getTermSuggestions</a></li><li data-type='method'><a href="EcomSearch.html#getTotalCount">getTotalCount</a></li><li data-type='method'><a href="EcomSearch.html#mergeFilter">mergeFilter</a></li><li data-type='method'><a href="EcomSearch.html#removeFilter">removeFilter</a></li><li data-type='method'><a href="EcomSearch.html#reset">reset</a></li><li data-type='method'><a href="EcomSearch.html#setBrandIds">setBrandIds</a></li><li data-type='method'><a href="EcomSearch.html#setBrandNames">setBrandNames</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryIds">setCategoryIds</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryNames">setCategoryNames</a></li><li data-type='method'><a href="EcomSearch.html#setPageNumber">setPageNumber</a></li><li data-type='method'><a href="EcomSearch.html#setPageSize">setPageSize</a></li><li data-type='method'><a href="EcomSearch.html#setPriceRange">setPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#setProductIds">setProductIds</a></li><li data-type='method'><a href="EcomSearch.html#setSearchTerm">setSearchTerm</a></li><li data-type='method'><a href="EcomSearch.html#setSkus">setSkus</a></li><li data-type='method'><a href="EcomSearch.html#setSortOrder">setSortOrder</a></li><li data-type='method'><a href="EcomSearch.html#setSpec">setSpec</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-@ecomplus_search-engine.html">@ecomplus/search-engine</a></li></ul><h3><a href="global.html">Global</a></h3>
30+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EcomSearch.html">EcomSearch</a><ul class='methods'><li data-type='method'><a href="EcomSearch.html#fetch">fetch</a></li><li data-type='method'><a href="EcomSearch.html#getBrands">getBrands</a></li><li data-type='method'><a href="EcomSearch.html#getCategories">getCategories</a></li><li data-type='method'><a href="EcomSearch.html#getItems">getItems</a></li><li data-type='method'><a href="EcomSearch.html#getPriceRange">getPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#getSpecs">getSpecs</a></li><li data-type='method'><a href="EcomSearch.html#getTermSuggestions">getTermSuggestions</a></li><li data-type='method'><a href="EcomSearch.html#getTotalCount">getTotalCount</a></li><li data-type='method'><a href="EcomSearch.html#mergeFilter">mergeFilter</a></li><li data-type='method'><a href="EcomSearch.html#removeFilter">removeFilter</a></li><li data-type='method'><a href="EcomSearch.html#reset">reset</a></li><li data-type='method'><a href="EcomSearch.html#setBrandIds">setBrandIds</a></li><li data-type='method'><a href="EcomSearch.html#setBrandNames">setBrandNames</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryIds">setCategoryIds</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryNames">setCategoryNames</a></li><li data-type='method'><a href="EcomSearch.html#setPageNumber">setPageNumber</a></li><li data-type='method'><a href="EcomSearch.html#setPageSize">setPageSize</a></li><li data-type='method'><a href="EcomSearch.html#setPriceRange">setPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#setProductIds">setProductIds</a></li><li data-type='method'><a href="EcomSearch.html#setSearchTerm">setSearchTerm</a></li><li data-type='method'><a href="EcomSearch.html#setSkus">setSkus</a></li><li data-type='method'><a href="EcomSearch.html#setSortOrder">setSortOrder</a></li><li data-type='method'><a href="EcomSearch.html#setSpec">setSpec</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-@ecomplus_search-engine.html">@ecomplus/search-engine</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addGlobalFilter">addGlobalFilter</a></li><li><a href="global.html#setSalesChannel">setSalesChannel</a></li><li><a href="global.html#setWarehouse">setWarehouse</a></li></ul>
3131
</nav>
3232

3333
<div id="main">
3434

35-
<h1 class="page-title">index.js</h1>
35+
<h1 class="page-title">constructor.js</h1>
3636

3737

3838

@@ -42,13 +42,7 @@ <h1 class="page-title">index.js</h1>
4242

4343
<section>
4444
<article>
45-
<pre class="prettyprint source linenums"><code>/*!
46-
* @ecomplus/search-engine
47-
* (c) E-Com Club &lt;ti@e-com.club>
48-
* Released under the MIT License.
49-
*/
50-
51-
/**
45+
<pre class="prettyprint source linenums"><code>/**
5246
* JS lib to handle products search with E-Com Plus stores.
5347
* {@link https://github.com/ecomclub/search-engine GitHub}
5448
*
@@ -225,7 +219,7 @@ <h1 class="page-title">index.js</h1>
225219
<br class="clear">
226220

227221
<footer>
228-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Nov 26 2020 20:36:12 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
222+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 31 2021 21:14:40 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
229223
</footer>
230224

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

0 commit comments

Comments
 (0)