Skip to content

Commit 404d18f

Browse files
committed
docs(generate): update jsdoc/docdash generated documentation
1 parent bb689ea commit 404d18f

28 files changed

+176
-63
lines changed

docs/EcomSearch.html

Lines changed: 117 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2279,7 +2279,7 @@ <h5>Returns:</h5>
22792279

22802280

22812281

2282-
<h4 class="name" id="mergeFilter"><span class="type-signature"></span>mergeFilter<span class="signature">(filter)</span><span class="type-signature"> &rarr; {self}</span></h4>
2282+
<h4 class="name" id="mergeFilter"><span class="type-signature"></span>mergeFilter<span class="signature">(filter, occur<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {self}</span></h4>
22832283

22842284

22852285

@@ -2291,7 +2291,7 @@ <h4 class="name" id="mergeFilter"><span class="type-signature"></span>mergeFilte
22912291

22922292
<dt class="tag-source">Source:</dt>
22932293
<dd class="tag-source"><ul class="dummy"><li>
2294-
<a href="methods_merge-filter.js.html">methods/merge-filter.js</a>, <a href="methods_merge-filter.js.html#line70">line 70</a>
2294+
<a href="methods_merge-filter.js.html">methods/merge-filter.js</a>, <a href="methods_merge-filter.js.html#line71">line 71</a>
22952295
</li></ul></dd>
22962296

22972297

@@ -2372,8 +2372,12 @@ <h5>Parameters:</h5>
23722372
<th>Type</th>
23732373

23742374

2375+
<th>Attributes</th>
2376+
23752377

23762378

2379+
<th>Default</th>
2380+
23772381

23782382
<th class="last">Description</th>
23792383
</tr>
@@ -2397,14 +2401,66 @@ <h5>Parameters:</h5>
23972401
</td>
23982402

23992403

2404+
<td class="attributes">
2405+
24002406

2407+
2408+
2409+
2410+
</td>
2411+
2412+
2413+
2414+
<td class="default">
2415+
2416+
</td>
24012417

24022418

24032419
<td class="description last">A valid object for Query DSL
24042420
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html">filter context</a></td>
24052421
</tr>
24062422

24072423

2424+
2425+
<tr>
2426+
2427+
<td class="name"><code>occur</code></td>
2428+
2429+
2430+
<td class="type">
2431+
2432+
2433+
<span class="param-type">string</span>
2434+
2435+
2436+
2437+
</td>
2438+
2439+
2440+
<td class="attributes">
2441+
2442+
&lt;optional><br>
2443+
2444+
2445+
2446+
2447+
2448+
</td>
2449+
2450+
2451+
2452+
<td class="default">
2453+
2454+
<code>'filter'</code>
2455+
2456+
</td>
2457+
2458+
2459+
<td class="description last">Occurrence type for
2460+
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html">boolean query</a></td>
2461+
</tr>
2462+
2463+
24082464
</tbody>
24092465
</table>
24102466

@@ -2449,7 +2505,7 @@ <h5>Returns:</h5>
24492505

24502506

24512507

2452-
<h4 class="name" id="removeFilter"><span class="type-signature"></span>removeFilter<span class="signature">(field)</span><span class="type-signature"> &rarr; {self}</span></h4>
2508+
<h4 class="name" id="removeFilter"><span class="type-signature"></span>removeFilter<span class="signature">(field, occur<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {self}</span></h4>
24532509

24542510

24552511

@@ -2537,8 +2593,12 @@ <h5>Parameters:</h5>
25372593
<th>Type</th>
25382594

25392595

2596+
<th>Attributes</th>
2597+
25402598

25412599

2600+
<th>Default</th>
2601+
25422602

25432603
<th class="last">Description</th>
25442604
</tr>
@@ -2562,7 +2622,19 @@ <h5>Parameters:</h5>
25622622
</td>
25632623

25642624

2625+
<td class="attributes">
2626+
25652627

2628+
2629+
2630+
2631+
</td>
2632+
2633+
2634+
2635+
<td class="default">
2636+
2637+
</td>
25662638

25672639

25682640
<td class="description last">A valid
@@ -2571,6 +2643,46 @@ <h5>Parameters:</h5>
25712643
</tr>
25722644

25732645

2646+
2647+
<tr>
2648+
2649+
<td class="name"><code>occur</code></td>
2650+
2651+
2652+
<td class="type">
2653+
2654+
2655+
<span class="param-type">string</span>
2656+
2657+
2658+
2659+
</td>
2660+
2661+
2662+
<td class="attributes">
2663+
2664+
&lt;optional><br>
2665+
2666+
2667+
2668+
2669+
2670+
</td>
2671+
2672+
2673+
2674+
<td class="default">
2675+
2676+
<code>'filter'</code>
2677+
2678+
</td>
2679+
2680+
2681+
<td class="description last">Occurrence type for
2682+
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html">boolean query</a></td>
2683+
</tr>
2684+
2685+
25742686
</tbody>
25752687
</table>
25762688

@@ -4137,7 +4249,7 @@ <h4 class="name" id="setSearchTerm"><span class="type-signature"></span>setSearc
41374249

41384250
<dt class="tag-source">Source:</dt>
41394251
<dd class="tag-source"><ul class="dummy"><li>
4140-
<a href="methods_set-search-term.js.html">methods/set-search-term.js</a>, <a href="methods_set-search-term.js.html#line37">line 37</a>
4252+
<a href="methods_set-search-term.js.html">methods/set-search-term.js</a>, <a href="methods_set-search-term.js.html#line33">line 33</a>
41414253
</li></ul></dd>
41424254

41434255

@@ -4863,7 +4975,7 @@ <h5>Returns:</h5>
48634975
<br class="clear">
48644976

48654977
<footer>
4866-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
4978+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
48674979
</footer>
48684980

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

docs/global.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1068,7 +1068,7 @@ <h5>Type:</h5>
10681068
<br class="clear">
10691069

10701070
<footer>
1071-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1071+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
10721072
</footer>
10731073

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

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h4>CDN</h4>
112112
<br class="clear">
113113

114114
<footer>
115-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
115+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
116116
</footer>
117117

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

docs/index.js.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ <h1 class="page-title">index.js</h1>
162162
this.setPageNumber = page => setPageNumber(self, page)
163163
this.setPageSize = limit => setPageSize(self, limit)
164164
this.setSortOrder = enumOrder => setSortOrder(self, enumOrder)
165-
this.mergeFilter = filter => mergeFilter(self, filter)
166-
this.removeFilter = field => removeFilter(self, field)
165+
this.mergeFilter = (filter, occur) => mergeFilter(self, filter, occur)
166+
this.removeFilter = (field, occur) => removeFilter(self, field, occur)
167167
this.setSpec = (gridId, textOptions) => setSpec(self, gridId, textOptions)
168168
this.setCategoryNames = categoryNames => setCategoryNames(self, categoryNames)
169169
this.setCategoryIds = categoryIds => setCategoryIds(self, categoryIds)
@@ -225,7 +225,7 @@ <h1 class="page-title">index.js</h1>
225225
<br class="clear">
226226

227227
<footer>
228-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
228+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
229229
</footer>
230230

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

docs/methods_fetch.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1 class="page-title">methods/fetch.js</h1>
126126
<br class="clear">
127127

128128
<footer>
129-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
129+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
130130
</footer>
131131

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

docs/methods_get-brands.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h1 class="page-title">methods/get-brands.js</h1>
8484
<br class="clear">
8585

8686
<footer>
87-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
87+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
8888
</footer>
8989

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

docs/methods_get-categories.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h1 class="page-title">methods/get-categories.js</h1>
7878
<br class="clear">
7979

8080
<footer>
81-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
81+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
8282
</footer>
8383

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

docs/methods_get-items.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h1 class="page-title">methods/get-items.js</h1>
8989
<br class="clear">
9090

9191
<footer>
92-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
92+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
9393
</footer>
9494

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

docs/methods_get-price-range.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h1 class="page-title">methods/get-price-range.js</h1>
9393
<br class="clear">
9494

9595
<footer>
96-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
96+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
9797
</footer>
9898

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

docs/methods_get-specs.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h1 class="page-title">methods/get-specs.js</h1>
103103
<br class="clear">
104104

105105
<footer>
106-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Fri May 15 2020 16:48:56 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
106+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat May 23 2020 18:31:52 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
107107
</footer>
108108

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

0 commit comments

Comments
 (0)