musora-content-services 1.0.9 → 1.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  3. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  4. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  5. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  6. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  7. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  8. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  9. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  10. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  11. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
  12. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  13. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  14. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  15. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  16. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
  17. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  18. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  19. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  20. package/docs/global.html +947 -933
  21. package/docs/index.html +27 -9
  22. package/docs/index.js.html +147 -51
  23. package/docs/scripts/collapse.js +39 -0
  24. package/docs/scripts/commonNav.js +28 -0
  25. package/docs/scripts/nav.js +12 -0
  26. package/docs/scripts/polyfill.js +4 -0
  27. package/docs/scripts/search.js +99 -265
  28. package/docs/styles/jsdoc.css +776 -0
  29. package/docs/styles/prettify.css +80 -0
  30. package/jsdoc.json +1 -1
  31. package/package.json +5 -4
  32. package/src/index.js +127 -43
package/docs/global.html CHANGED
@@ -1,18 +1,21 @@
1
1
  <!DOCTYPE html>
2
2
  <html lang="en">
3
3
  <head>
4
+
4
5
  <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width,initial-scale=1">
6
6
  <title>Global - Documentation</title>
7
-
7
+
8
+
8
9
  <script src="scripts/prettify/prettify.js"></script>
9
10
  <script src="scripts/prettify/lang-css.js"></script>
10
11
  <!--[if lt IE 9]>
11
12
  <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12
13
  <![endif]-->
13
- <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
16
19
  </head>
17
20
  <body>
18
21
 
@@ -23,8 +26,11 @@
23
26
 
24
27
  <label for="nav-trigger" class="overlay"></label>
25
28
 
26
- <nav>
27
- <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchAll">fetchAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchAllFilterOptions">fetchAllFilterOptions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchAllSongs">fetchAllSongs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchArtists">fetchArtists</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchByRailContentId">fetchByRailContentId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchByRailContentIds">fetchByRailContentIds</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchChildren">fetchChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchLessonContent">fetchLessonContent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchMethodChildren">fetchMethodChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchMethodNextLesson">fetchMethodNextLesson</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchNewReleases">fetchNewReleases</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchNextPreviousLesson">fetchNextPreviousLesson</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchPackAll">fetchPackAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchPackChildren">fetchPackChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchRelatedLessons">fetchRelatedLessons</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchRelatedSongs">fetchRelatedSongs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSanity">fetchSanity</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongArtistCount">fetchSongArtistCount</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongById">fetchSongById</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongCount">fetchSongCount</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongFilterOptions">fetchSongFilterOptions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchUpcomingEvents">fetchUpcomingEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchWorkouts">fetchWorkouts</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#initializeSanityService">initializeSanityService</a></span></li>
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#fetchAll">fetchAll</a></li><li><a href="global.html#fetchAllFilterOptions">fetchAllFilterOptions</a></li><li><a href="global.html#fetchAllSongs">fetchAllSongs</a></li><li><a href="global.html#fetchArtists">fetchArtists</a></li><li><a href="global.html#fetchByRailContentId">fetchByRailContentId</a></li><li><a href="global.html#fetchByRailContentIds">fetchByRailContentIds</a></li><li><a href="global.html#fetchChildren">fetchChildren</a></li><li><a href="global.html#fetchLessonContent">fetchLessonContent</a></li><li><a href="global.html#fetchMethodChildren">fetchMethodChildren</a></li><li><a href="global.html#fetchMethodNextLesson">fetchMethodNextLesson</a></li><li><a href="global.html#fetchNewReleases">fetchNewReleases</a></li><li><a href="global.html#fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li><a href="global.html#fetchPackAll">fetchPackAll</a></li><li><a href="global.html#fetchPackChildren">fetchPackChildren</a></li><li><a href="global.html#fetchRelatedLessons">fetchRelatedLessons</a></li><li><a href="global.html#fetchRelatedSongs">fetchRelatedSongs</a></li><li><a href="global.html#fetchSanity">fetchSanity</a></li><li><a href="global.html#fetchSongArtistCount">fetchSongArtistCount</a></li><li><a href="global.html#fetchSongById">fetchSongById</a></li><li><a href="global.html#fetchSongCount">fetchSongCount</a></li><li><a href="global.html#fetchSongFilterOptions">fetchSongFilterOptions</a></li><li><a href="global.html#fetchUpcomingEvents">fetchUpcomingEvents</a></li><li><a href="global.html#fetchWorkouts">fetchWorkouts</a></li><li><a href="global.html#initializeSanityService">initializeSanityService</a></li></ul>
33
+
28
34
  </nav>
29
35
 
30
36
  <div id="main">
@@ -43,20 +49,21 @@
43
49
 
44
50
  <h2>
45
51
 
52
+
53
+
46
54
  </h2>
47
55
 
48
56
 
49
57
  </header>
50
58
 
51
59
  <article>
52
- <div class="container-overview">
53
60
 
61
+ <div class="container-overview">
54
62
 
55
-
56
-
57
-
63
+
58
64
 
59
65
  <dl class="details">
66
+
60
67
 
61
68
 
62
69
 
@@ -92,15 +99,22 @@
92
99
  </dl>
93
100
 
94
101
 
102
+
103
+
104
+
105
+
106
+
95
107
 
108
+ </div>
96
109
 
97
- </div>
98
110
 
99
111
 
100
112
 
101
113
 
102
114
 
103
115
 
116
+
117
+
104
118
 
105
119
 
106
120
 
@@ -113,29 +127,28 @@
113
127
 
114
128
 
115
129
 
116
- <div class="section-method">
117
130
 
118
131
 
119
132
 
120
- <h4 class="name" id="fetchAll"><span class="type-signature">(async) </span>fetchAll<span class="signature">(brand, type, params)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
133
+ <h4 class="name" id="fetchAll"><span class="type-signature type-signature-async">(async) </span>fetchAll<span class="signature">(brand, type, params)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
121
134
 
122
135
 
123
136
 
124
137
 
125
138
 
126
- <div class="description">
127
- Fetch all content for a specific brand and type with pagination, search, and grouping options.
128
- </div>
129
-
130
-
131
-
132
-
133
139
 
134
140
  <dl class="details">
135
-
141
+
142
+ <dt class="tag-description">Description:</dt>
143
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all content for a specific brand and type with pagination, search, and grouping options.</li></ul></dd>
136
144
 
137
145
 
138
146
 
147
+ <dt class="tag-source">Source:</dt>
148
+ <dd class="tag-source"><ul class="dummy"><li>
149
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line530">line 530</a>
150
+ </li></ul></dd>
151
+
139
152
 
140
153
 
141
154
 
@@ -158,10 +171,7 @@
158
171
 
159
172
 
160
173
 
161
- <dt class="tag-source">Source:</dt>
162
- <dd class="tag-source"><ul class="dummy"><li>
163
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line463">line 463</a>
164
- </li></ul></dd>
174
+
165
175
 
166
176
 
167
177
 
@@ -179,7 +189,25 @@
179
189
 
180
190
 
181
191
 
182
- <h5>Parameters:</h5>
192
+
193
+
194
+ <h5 class="h5-examples">Example</h5>
195
+
196
+ <pre class="prettyprint"><code>fetchAll('drumeo', 'song', {
197
+ page: 2,
198
+ limit: 20,
199
+ searchTerm: 'jazz',
200
+ sort: '-popularity',
201
+ includedFields: ['difficulty,Intermediate'],
202
+ groupBy: 'artist'
203
+ })
204
+ .then(content => console.log(content))
205
+ .catch(error => console.error(error));</code></pre>
206
+
207
+
208
+
209
+
210
+ <h5 class="h5-parameters">Parameters:</h5>
183
211
 
184
212
 
185
213
  <table class="params">
@@ -210,7 +238,8 @@
210
238
  <td class="type">
211
239
 
212
240
 
213
- <span class="param-type"><code>string</code></span>
241
+ <span class="param-type">string</span>
242
+
214
243
 
215
244
 
216
245
 
@@ -220,10 +249,7 @@
220
249
 
221
250
 
222
251
 
223
- <td class="description last">
224
- The brand for which to fetch content.
225
-
226
- </td>
252
+ <td class="description last">The brand for which to fetch content.</td>
227
253
  </tr>
228
254
 
229
255
 
@@ -236,7 +262,8 @@
236
262
  <td class="type">
237
263
 
238
264
 
239
- <span class="param-type"><code>string</code></span>
265
+ <span class="param-type">string</span>
266
+
240
267
 
241
268
 
242
269
 
@@ -246,10 +273,7 @@
246
273
 
247
274
 
248
275
 
249
- <td class="description last">
250
- The content type to fetch (e.g., 'song', 'artist').
251
-
252
- </td>
276
+ <td class="description last">The content type to fetch (e.g., 'song', 'artist').</td>
253
277
  </tr>
254
278
 
255
279
 
@@ -262,7 +286,8 @@
262
286
  <td class="type">
263
287
 
264
288
 
265
- <span class="param-type"><code>Object</code></span>
289
+ <span class="param-type">Object</span>
290
+
266
291
 
267
292
 
268
293
 
@@ -272,10 +297,9 @@
272
297
 
273
298
 
274
299
 
275
- <td class="description last">
276
- Parameters for pagination, filtering, sorting, and grouping.
300
+ <td class="description last">Parameters for pagination, filtering, sorting, and grouping.
301
+ <h6>Properties</h6>
277
302
 
278
-
279
303
 
280
304
  <table class="params">
281
305
  <thead>
@@ -309,7 +333,8 @@
309
333
  <td class="type">
310
334
 
311
335
 
312
- <span class="param-type"><code>number</code></span>
336
+ <span class="param-type">number</span>
337
+
313
338
 
314
339
 
315
340
 
@@ -330,15 +355,12 @@
330
355
 
331
356
  <td class="default">
332
357
 
333
- 1
358
+ <code>1</code>
334
359
 
335
360
  </td>
336
361
 
337
362
 
338
- <td class="description last">
339
- The page number for pagination.
340
-
341
- </td>
363
+ <td class="description last">The page number for pagination.</td>
342
364
  </tr>
343
365
 
344
366
 
@@ -351,7 +373,8 @@
351
373
  <td class="type">
352
374
 
353
375
 
354
- <span class="param-type"><code>number</code></span>
376
+ <span class="param-type">number</span>
377
+
355
378
 
356
379
 
357
380
 
@@ -372,15 +395,12 @@
372
395
 
373
396
  <td class="default">
374
397
 
375
- 10
398
+ <code>10</code>
376
399
 
377
400
  </td>
378
401
 
379
402
 
380
- <td class="description last">
381
- The number of items per page.
382
-
383
- </td>
403
+ <td class="description last">The number of items per page.</td>
384
404
  </tr>
385
405
 
386
406
 
@@ -393,7 +413,8 @@
393
413
  <td class="type">
394
414
 
395
415
 
396
- <span class="param-type"><code>string</code></span>
416
+ <span class="param-type">string</span>
417
+
397
418
 
398
419
 
399
420
 
@@ -414,15 +435,12 @@
414
435
 
415
436
  <td class="default">
416
437
 
417
- ""
438
+ <code>""</code>
418
439
 
419
440
  </td>
420
441
 
421
442
 
422
- <td class="description last">
423
- The search term to filter content by title or artist.
424
-
425
- </td>
443
+ <td class="description last">The search term to filter content by title or artist.</td>
426
444
  </tr>
427
445
 
428
446
 
@@ -435,7 +453,8 @@
435
453
  <td class="type">
436
454
 
437
455
 
438
- <span class="param-type"><code>string</code></span>
456
+ <span class="param-type">string</span>
457
+
439
458
 
440
459
 
441
460
 
@@ -456,15 +475,12 @@
456
475
 
457
476
  <td class="default">
458
477
 
459
- "-published_on"
478
+ <code>"-published_on"</code>
460
479
 
461
480
  </td>
462
481
 
463
482
 
464
- <td class="description last">
465
- The field to sort the content by.
466
-
467
- </td>
483
+ <td class="description last">The field to sort the content by.</td>
468
484
  </tr>
469
485
 
470
486
 
@@ -477,7 +493,8 @@
477
493
  <td class="type">
478
494
 
479
495
 
480
- <span class="param-type"><code>Array.&lt;string></code></span>
496
+ <span class="param-type">Array.&lt;string></span>
497
+
481
498
 
482
499
 
483
500
 
@@ -498,15 +515,12 @@
498
515
 
499
516
  <td class="default">
500
517
 
501
- []
518
+ <code>[]</code>
502
519
 
503
520
  </td>
504
521
 
505
522
 
506
- <td class="description last">
507
- The fields to include in the query.
508
-
509
- </td>
523
+ <td class="description last">The fields to include in the query.</td>
510
524
  </tr>
511
525
 
512
526
 
@@ -519,7 +533,8 @@
519
533
  <td class="type">
520
534
 
521
535
 
522
- <span class="param-type"><code>string</code></span>
536
+ <span class="param-type">string</span>
537
+
523
538
 
524
539
 
525
540
 
@@ -540,22 +555,18 @@
540
555
 
541
556
  <td class="default">
542
557
 
543
- ""
558
+ <code>""</code>
544
559
 
545
560
  </td>
546
561
 
547
562
 
548
- <td class="description last">
549
- The field to group the results by (e.g., 'artist', 'genre').
550
-
551
- </td>
563
+ <td class="description last">The field to group the results by (e.g., 'artist', 'genre').</td>
552
564
  </tr>
553
565
 
554
566
 
555
567
  </tbody>
556
568
  </table>
557
569
 
558
-
559
570
  </td>
560
571
  </tr>
561
572
 
@@ -576,62 +587,61 @@
576
587
 
577
588
 
578
589
 
579
- <div class="section-returns">
580
- <h5>Returns:</h5>
590
+
591
+
592
+ <h5 class="h5-returns">Returns:</h5>
581
593
 
582
594
 
595
+ <div class="param-desc">
596
+ - The fetched content data or null if not found.
597
+ </div>
598
+
599
+
583
600
 
584
601
  <dl class="param-type">
585
602
  <dt>
586
- Type:
603
+ Type
587
604
  </dt>
588
605
  <dd>
589
606
 
590
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
607
+ <span class="param-type">Promise.&lt;(Object|null)></span>
608
+
591
609
 
592
610
 
593
611
  </dd>
594
612
  </dl>
595
613
 
596
-
597
- <div class="param-desc">
598
- - The fetched content data or null if not found.
599
- </div>
600
-
601
614
 
602
- </div>
603
615
 
604
616
 
605
617
 
606
- </div>
607
618
 
608
619
 
609
- <div class="section-method">
610
620
 
611
621
 
612
622
 
613
- <h4 class="name" id="fetchAllFilterOptions"><span class="type-signature">(async) </span>fetchAllFilterOptions<span class="signature">(brand, filters, style<span class="signature-attributes">opt</span>, artist<span class="signature-attributes">opt</span>, contentType, term<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
623
+ <h4 class="name" id="fetchAllFilterOptions"><span class="type-signature type-signature-async">(async) </span>fetchAllFilterOptions<span class="signature">(brand, filters, style<span class="signature-attributes">opt</span>, artist<span class="signature-attributes">opt</span>, contentType, term<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
614
624
 
615
625
 
616
626
 
617
627
 
618
628
 
619
- <div class="description">
620
- Fetches all available filter options based on various criteria such as brand, filters, style, artist, content type, and search term.
621
-
622
- This function constructs a query to retrieve the total number of results and filter options such as difficulty, instrument type, and genre.
623
- The filter options are dynamically generated based on the provided filters, style, artist, and content type.
624
- </div>
625
-
626
-
627
-
628
-
629
629
 
630
630
  <dl class="details">
631
+
632
+ <dt class="tag-description">Description:</dt>
633
+ <dd class="tag-description"><ul class="dummy"><li>Fetches all available filter options based on various criteria such as brand, filters, style, artist, content type, and search term.
631
634
 
635
+ This function constructs a query to retrieve the total number of results and filter options such as difficulty, instrument type, and genre.
636
+ The filter options are dynamically generated based on the provided filters, style, artist, and content type.</li></ul></dd>
632
637
 
633
638
 
634
639
 
640
+ <dt class="tag-source">Source:</dt>
641
+ <dd class="tag-source"><ul class="dummy"><li>
642
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line674">line 674</a>
643
+ </li></ul></dd>
644
+
635
645
 
636
646
 
637
647
 
@@ -654,10 +664,7 @@ The filter options are dynamically generated based on the provided filters, styl
654
664
 
655
665
 
656
666
 
657
- <dt class="tag-source">Source:</dt>
658
- <dd class="tag-source"><ul class="dummy"><li>
659
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line607">line 607</a>
660
- </li></ul></dd>
667
+
661
668
 
662
669
 
663
670
 
@@ -675,7 +682,19 @@ The filter options are dynamically generated based on the provided filters, styl
675
682
 
676
683
 
677
684
 
678
- <h5>Parameters:</h5>
685
+
686
+
687
+ <h5 class="h5-examples">Example</h5>
688
+
689
+ <pre class="prettyprint"><code>// Example usage:
690
+ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
691
+ .then(options => console.log(options))
692
+ .catch(error => console.error(error));</code></pre>
693
+
694
+
695
+
696
+
697
+ <h5 class="h5-parameters">Parameters:</h5>
679
698
 
680
699
 
681
700
  <table class="params">
@@ -708,7 +727,8 @@ The filter options are dynamically generated based on the provided filters, styl
708
727
  <td class="type">
709
728
 
710
729
 
711
- <span class="param-type"><code>string</code></span>
730
+ <span class="param-type">string</span>
731
+
712
732
 
713
733
 
714
734
 
@@ -726,10 +746,7 @@ The filter options are dynamically generated based on the provided filters, styl
726
746
 
727
747
 
728
748
 
729
- <td class="description last">
730
- The brand for which to fetch the filter options.
731
-
732
- </td>
749
+ <td class="description last">The brand for which to fetch the filter options.</td>
733
750
  </tr>
734
751
 
735
752
 
@@ -742,7 +759,8 @@ The filter options are dynamically generated based on the provided filters, styl
742
759
  <td class="type">
743
760
 
744
761
 
745
- <span class="param-type"><code>string</code></span>
762
+ <span class="param-type">string</span>
763
+
746
764
 
747
765
 
748
766
 
@@ -760,10 +778,7 @@ The filter options are dynamically generated based on the provided filters, styl
760
778
 
761
779
 
762
780
 
763
- <td class="description last">
764
- Additional filters to apply to the query, typically in the format of Sanity GROQ queries.
765
-
766
- </td>
781
+ <td class="description last">Additional filters to apply to the query, typically in the format of Sanity GROQ queries.</td>
767
782
  </tr>
768
783
 
769
784
 
@@ -776,7 +791,8 @@ The filter options are dynamically generated based on the provided filters, styl
776
791
  <td class="type">
777
792
 
778
793
 
779
- <span class="param-type"><code>string</code></span>
794
+ <span class="param-type">string</span>
795
+
780
796
 
781
797
 
782
798
 
@@ -796,10 +812,7 @@ The filter options are dynamically generated based on the provided filters, styl
796
812
 
797
813
 
798
814
 
799
- <td class="description last">
800
- Optional style or genre to filter the results. If provided, the query will check if the style exists in the genre array.
801
-
802
- </td>
815
+ <td class="description last">Optional style or genre to filter the results. If provided, the query will check if the style exists in the genre array.</td>
803
816
  </tr>
804
817
 
805
818
 
@@ -812,7 +825,8 @@ The filter options are dynamically generated based on the provided filters, styl
812
825
  <td class="type">
813
826
 
814
827
 
815
- <span class="param-type"><code>string</code></span>
828
+ <span class="param-type">string</span>
829
+
816
830
 
817
831
 
818
832
 
@@ -832,10 +846,7 @@ The filter options are dynamically generated based on the provided filters, styl
832
846
 
833
847
 
834
848
 
835
- <td class="description last">
836
- Optional artist name to filter the results. If provided, the query will check if the artist's name matches.
837
-
838
- </td>
849
+ <td class="description last">Optional artist name to filter the results. If provided, the query will check if the artist's name matches.</td>
839
850
  </tr>
840
851
 
841
852
 
@@ -848,7 +859,8 @@ The filter options are dynamically generated based on the provided filters, styl
848
859
  <td class="type">
849
860
 
850
861
 
851
- <span class="param-type"><code>string</code></span>
862
+ <span class="param-type">string</span>
863
+
852
864
 
853
865
 
854
866
 
@@ -866,10 +878,7 @@ The filter options are dynamically generated based on the provided filters, styl
866
878
 
867
879
 
868
880
 
869
- <td class="description last">
870
- The content type to fetch (e.g., 'song', 'lesson').
871
-
872
- </td>
881
+ <td class="description last">The content type to fetch (e.g., 'song', 'lesson').</td>
873
882
  </tr>
874
883
 
875
884
 
@@ -882,7 +891,8 @@ The filter options are dynamically generated based on the provided filters, styl
882
891
  <td class="type">
883
892
 
884
893
 
885
- <span class="param-type"><code>string</code></span>
894
+ <span class="param-type">string</span>
895
+
886
896
 
887
897
 
888
898
 
@@ -902,10 +912,7 @@ The filter options are dynamically generated based on the provided filters, styl
902
912
 
903
913
 
904
914
 
905
- <td class="description last">
906
- Optional search term to match against various fields such as title, album, artist name, and genre.
907
-
908
- </td>
915
+ <td class="description last">Optional search term to match against various fields such as title, album, artist name, and genre.</td>
909
916
  </tr>
910
917
 
911
918
 
@@ -925,69 +932,58 @@ The filter options are dynamically generated based on the provided filters, styl
925
932
 
926
933
 
927
934
 
928
- <div class="section-returns">
929
- <h5>Returns:</h5>
935
+
936
+
937
+ <h5 class="h5-returns">Returns:</h5>
930
938
 
931
939
 
940
+ <div class="param-desc">
941
+ - A promise that resolves to an object containing the total results and filter options, or null if the query fails.
942
+ </div>
943
+
944
+
932
945
 
933
946
  <dl class="param-type">
934
947
  <dt>
935
- Type:
948
+ Type
936
949
  </dt>
937
950
  <dd>
938
951
 
939
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
952
+ <span class="param-type">Promise.&lt;(Object|null)></span>
953
+
940
954
 
941
955
 
942
956
  </dd>
943
957
  </dl>
944
958
 
945
-
946
- <div class="param-desc">
947
- - A promise that resolves to an object containing the total results and filter options, or null if the query fails.
948
- </div>
949
-
950
959
 
951
- </div>
952
-
953
960
 
954
961
 
955
- <div class="section-examples">
956
- <h5>Example</h5>
957
-
958
- <pre class="prettyprint"><code>// Example usage:
959
- fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
960
- .then(options => console.log(options))
961
- .catch(error => console.error(error));</code></pre>
962
-
963
- </div>
964
962
 
965
- </div>
966
963
 
967
964
 
968
- <div class="section-method">
969
965
 
970
966
 
971
967
 
972
- <h4 class="name" id="fetchAllSongs"><span class="type-signature">(async) </span>fetchAllSongs<span class="signature">(brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
968
+ <h4 class="name" id="fetchAllSongs"><span class="type-signature type-signature-async">(async) </span>fetchAllSongs<span class="signature">(brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
973
969
 
974
970
 
975
971
 
976
972
 
977
973
 
978
- <div class="description">
979
- Fetch all songs for a specific brand with pagination and search options.
980
- </div>
981
-
982
-
983
-
984
-
985
974
 
986
975
  <dl class="details">
987
-
976
+
977
+ <dt class="tag-description">Description:</dt>
978
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all songs for a specific brand with pagination and search options.</li></ul></dd>
988
979
 
989
980
 
990
981
 
982
+ <dt class="tag-source">Source:</dt>
983
+ <dd class="tag-source"><ul class="dummy"><li>
984
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line195">line 195</a>
985
+ </li></ul></dd>
986
+
991
987
 
992
988
 
993
989
 
@@ -1010,10 +1006,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1010
1006
 
1011
1007
 
1012
1008
 
1013
- <dt class="tag-source">Source:</dt>
1014
- <dd class="tag-source"><ul class="dummy"><li>
1015
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line164">line 164</a>
1016
- </li></ul></dd>
1009
+
1017
1010
 
1018
1011
 
1019
1012
 
@@ -1031,7 +1024,25 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1031
1024
 
1032
1025
 
1033
1026
 
1034
- <h5>Parameters:</h5>
1027
+
1028
+
1029
+ <h5 class="h5-examples">Example</h5>
1030
+
1031
+ <pre class="prettyprint"><code>fetchAllSongs('drumeo', {
1032
+ page: 2,
1033
+ limit: 20,
1034
+ searchTerm: 'rock',
1035
+ sort: 'published_on',
1036
+ includedFields: ['difficulty', 'style'],
1037
+ groupBy: 'artist'
1038
+ })
1039
+ .then(result => console.log(result))
1040
+ .catch(error => console.error(error));</code></pre>
1041
+
1042
+
1043
+
1044
+
1045
+ <h5 class="h5-parameters">Parameters:</h5>
1035
1046
 
1036
1047
 
1037
1048
  <table class="params">
@@ -1062,7 +1073,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1062
1073
  <td class="type">
1063
1074
 
1064
1075
 
1065
- <span class="param-type"><code>string</code></span>
1076
+ <span class="param-type">string</span>
1077
+
1066
1078
 
1067
1079
 
1068
1080
 
@@ -1072,10 +1084,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1072
1084
 
1073
1085
 
1074
1086
 
1075
- <td class="description last">
1076
- The brand for which to fetch songs.
1077
-
1078
- </td>
1087
+ <td class="description last">The brand for which to fetch songs.</td>
1079
1088
  </tr>
1080
1089
 
1081
1090
 
@@ -1088,7 +1097,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1088
1097
  <td class="type">
1089
1098
 
1090
1099
 
1091
- <span class="param-type"><code>Object</code></span>
1100
+ <span class="param-type">Object</span>
1101
+
1092
1102
 
1093
1103
 
1094
1104
 
@@ -1098,10 +1108,9 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1098
1108
 
1099
1109
 
1100
1110
 
1101
- <td class="description last">
1102
- Parameters for pagination, filtering, and sorting.
1111
+ <td class="description last">Parameters for pagination, filtering, and sorting.
1112
+ <h6>Properties</h6>
1103
1113
 
1104
-
1105
1114
 
1106
1115
  <table class="params">
1107
1116
  <thead>
@@ -1135,7 +1144,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1135
1144
  <td class="type">
1136
1145
 
1137
1146
 
1138
- <span class="param-type"><code>number</code></span>
1147
+ <span class="param-type">number</span>
1148
+
1139
1149
 
1140
1150
 
1141
1151
 
@@ -1156,15 +1166,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1156
1166
 
1157
1167
  <td class="default">
1158
1168
 
1159
- 1
1169
+ <code>1</code>
1160
1170
 
1161
1171
  </td>
1162
1172
 
1163
1173
 
1164
- <td class="description last">
1165
- The page number for pagination.
1166
-
1167
- </td>
1174
+ <td class="description last">The page number for pagination.</td>
1168
1175
  </tr>
1169
1176
 
1170
1177
 
@@ -1177,7 +1184,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1177
1184
  <td class="type">
1178
1185
 
1179
1186
 
1180
- <span class="param-type"><code>number</code></span>
1187
+ <span class="param-type">number</span>
1188
+
1181
1189
 
1182
1190
 
1183
1191
 
@@ -1198,15 +1206,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1198
1206
 
1199
1207
  <td class="default">
1200
1208
 
1201
- 10
1209
+ <code>10</code>
1202
1210
 
1203
1211
  </td>
1204
1212
 
1205
1213
 
1206
- <td class="description last">
1207
- The number of songs per page.
1208
-
1209
- </td>
1214
+ <td class="description last">The number of songs per page.</td>
1210
1215
  </tr>
1211
1216
 
1212
1217
 
@@ -1219,7 +1224,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1219
1224
  <td class="type">
1220
1225
 
1221
1226
 
1222
- <span class="param-type"><code>string</code></span>
1227
+ <span class="param-type">string</span>
1228
+
1223
1229
 
1224
1230
 
1225
1231
 
@@ -1240,15 +1246,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1240
1246
 
1241
1247
  <td class="default">
1242
1248
 
1243
- ""
1249
+ <code>""</code>
1244
1250
 
1245
1251
  </td>
1246
1252
 
1247
1253
 
1248
- <td class="description last">
1249
- The search term to filter songs by title or artist.
1250
-
1251
- </td>
1254
+ <td class="description last">The search term to filter songs by title or artist.</td>
1252
1255
  </tr>
1253
1256
 
1254
1257
 
@@ -1261,7 +1264,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1261
1264
  <td class="type">
1262
1265
 
1263
1266
 
1264
- <span class="param-type"><code>string</code></span>
1267
+ <span class="param-type">string</span>
1268
+
1265
1269
 
1266
1270
 
1267
1271
 
@@ -1282,15 +1286,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1282
1286
 
1283
1287
  <td class="default">
1284
1288
 
1285
- "-published_on"
1289
+ <code>"-published_on"</code>
1286
1290
 
1287
1291
  </td>
1288
1292
 
1289
1293
 
1290
- <td class="description last">
1291
- The field to sort the songs by.
1292
-
1293
- </td>
1294
+ <td class="description last">The field to sort the songs by.</td>
1294
1295
  </tr>
1295
1296
 
1296
1297
 
@@ -1303,7 +1304,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1303
1304
  <td class="type">
1304
1305
 
1305
1306
 
1306
- <span class="param-type"><code>Array.&lt;string></code></span>
1307
+ <span class="param-type">Array.&lt;string></span>
1308
+
1307
1309
 
1308
1310
 
1309
1311
 
@@ -1324,15 +1326,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1324
1326
 
1325
1327
  <td class="default">
1326
1328
 
1327
- []
1329
+ <code>[]</code>
1328
1330
 
1329
1331
  </td>
1330
1332
 
1331
1333
 
1332
- <td class="description last">
1333
- The fields to include in the query.
1334
-
1335
- </td>
1334
+ <td class="description last">The fields to include in the query.</td>
1336
1335
  </tr>
1337
1336
 
1338
1337
 
@@ -1345,7 +1344,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1345
1344
  <td class="type">
1346
1345
 
1347
1346
 
1348
- <span class="param-type"><code>string</code></span>
1347
+ <span class="param-type">string</span>
1348
+
1349
1349
 
1350
1350
 
1351
1351
 
@@ -1366,22 +1366,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1366
1366
 
1367
1367
  <td class="default">
1368
1368
 
1369
- ""
1369
+ <code>""</code>
1370
1370
 
1371
1371
  </td>
1372
1372
 
1373
1373
 
1374
- <td class="description last">
1375
- The field to group the results by.
1376
-
1377
- </td>
1374
+ <td class="description last">The field to group the results by.</td>
1378
1375
  </tr>
1379
1376
 
1380
1377
 
1381
1378
  </tbody>
1382
1379
  </table>
1383
1380
 
1384
-
1385
1381
  </td>
1386
1382
  </tr>
1387
1383
 
@@ -1402,59 +1398,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1402
1398
 
1403
1399
 
1404
1400
 
1405
- <div class="section-returns">
1406
- <h5>Returns:</h5>
1401
+
1402
+
1403
+ <h5 class="h5-returns">Returns:</h5>
1407
1404
 
1408
1405
 
1406
+ <div class="param-desc">
1407
+ - The fetched song data or null if not found.
1408
+ </div>
1409
+
1410
+
1409
1411
 
1410
1412
  <dl class="param-type">
1411
1413
  <dt>
1412
- Type:
1414
+ Type
1413
1415
  </dt>
1414
1416
  <dd>
1415
1417
 
1416
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
1418
+ <span class="param-type">Promise.&lt;(Object|null)></span>
1419
+
1417
1420
 
1418
1421
 
1419
1422
  </dd>
1420
1423
  </dl>
1421
1424
 
1422
-
1423
- <div class="param-desc">
1424
- - The fetched song data or null if not found.
1425
- </div>
1426
-
1427
1425
 
1428
- </div>
1429
1426
 
1430
1427
 
1431
1428
 
1432
- </div>
1433
1429
 
1434
1430
 
1435
- <div class="section-method">
1436
1431
 
1437
1432
 
1438
1433
 
1439
- <h4 class="name" id="fetchArtists"><span class="type-signature">(async) </span>fetchArtists<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
1434
+ <h4 class="name" id="fetchArtists"><span class="type-signature type-signature-async">(async) </span>fetchArtists<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
1440
1435
 
1441
1436
 
1442
1437
 
1443
1438
 
1444
1439
 
1445
- <div class="description">
1446
- Fetch all artists with lessons available for a specific brand.
1447
- </div>
1448
-
1449
-
1450
-
1451
-
1452
1440
 
1453
1441
  <dl class="details">
1454
-
1442
+
1443
+ <dt class="tag-description">Description:</dt>
1444
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all artists with lessons available for a specific brand.</li></ul></dd>
1455
1445
 
1456
1446
 
1457
1447
 
1448
+ <dt class="tag-source">Source:</dt>
1449
+ <dd class="tag-source"><ul class="dummy"><li>
1450
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line72">line 72</a>
1451
+ </li></ul></dd>
1452
+
1458
1453
 
1459
1454
 
1460
1455
 
@@ -1477,10 +1472,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1477
1472
 
1478
1473
 
1479
1474
 
1480
- <dt class="tag-source">Source:</dt>
1481
- <dd class="tag-source"><ul class="dummy"><li>
1482
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a>
1483
- </li></ul></dd>
1475
+
1484
1476
 
1485
1477
 
1486
1478
 
@@ -1498,7 +1490,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1498
1490
 
1499
1491
 
1500
1492
 
1501
- <h5>Parameters:</h5>
1493
+
1494
+
1495
+ <h5 class="h5-examples">Example</h5>
1496
+
1497
+ <pre class="prettyprint"><code>fetchArtists('drumeo')
1498
+ .then(artists => console.log(artists))
1499
+ .catch(error => console.error(error));</code></pre>
1500
+
1501
+
1502
+
1503
+
1504
+ <h5 class="h5-parameters">Parameters:</h5>
1502
1505
 
1503
1506
 
1504
1507
  <table class="params">
@@ -1529,7 +1532,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1529
1532
  <td class="type">
1530
1533
 
1531
1534
 
1532
- <span class="param-type"><code>string</code></span>
1535
+ <span class="param-type">string</span>
1536
+
1533
1537
 
1534
1538
 
1535
1539
 
@@ -1539,10 +1543,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1539
1543
 
1540
1544
 
1541
1545
 
1542
- <td class="description last">
1543
- The brand for which to fetch artists.
1544
-
1545
- </td>
1546
+ <td class="description last">The brand for which to fetch artists.</td>
1546
1547
  </tr>
1547
1548
 
1548
1549
 
@@ -1562,59 +1563,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1562
1563
 
1563
1564
 
1564
1565
 
1565
- <div class="section-returns">
1566
- <h5>Returns:</h5>
1566
+
1567
+
1568
+ <h5 class="h5-returns">Returns:</h5>
1567
1569
 
1568
1570
 
1571
+ <div class="param-desc">
1572
+ - A promise that resolves to an array of artist objects or null if not found.
1573
+ </div>
1574
+
1575
+
1569
1576
 
1570
1577
  <dl class="param-type">
1571
1578
  <dt>
1572
- Type:
1579
+ Type
1573
1580
  </dt>
1574
1581
  <dd>
1575
1582
 
1576
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
1583
+ <span class="param-type">Promise.&lt;(Object|null)></span>
1584
+
1577
1585
 
1578
1586
 
1579
1587
  </dd>
1580
1588
  </dl>
1581
1589
 
1582
-
1583
- <div class="param-desc">
1584
- - The fetched artist data or null if not found.
1585
- </div>
1586
-
1587
1590
 
1588
- </div>
1589
1591
 
1590
1592
 
1591
1593
 
1592
- </div>
1593
1594
 
1594
1595
 
1595
- <div class="section-method">
1596
1596
 
1597
1597
 
1598
1598
 
1599
- <h4 class="name" id="fetchByRailContentId"><span class="type-signature">(async) </span>fetchByRailContentId<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
1599
+ <h4 class="name" id="fetchByRailContentId"><span class="type-signature type-signature-async">(async) </span>fetchByRailContentId<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
1600
1600
 
1601
1601
 
1602
1602
 
1603
1603
 
1604
1604
 
1605
- <div class="description">
1606
- Fetch content by a specific Railcontent ID.
1607
- </div>
1608
-
1609
-
1610
-
1611
-
1612
1605
 
1613
1606
  <dl class="details">
1614
-
1607
+
1608
+ <dt class="tag-description">Description:</dt>
1609
+ <dd class="tag-description"><ul class="dummy"><li>Fetch content by a specific Railcontent ID.</li></ul></dd>
1615
1610
 
1616
1611
 
1617
1612
 
1613
+ <dt class="tag-source">Source:</dt>
1614
+ <dd class="tag-source"><ul class="dummy"><li>
1615
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line463">line 463</a>
1616
+ </li></ul></dd>
1617
+
1618
1618
 
1619
1619
 
1620
1620
 
@@ -1637,10 +1637,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1637
1637
 
1638
1638
 
1639
1639
 
1640
- <dt class="tag-source">Source:</dt>
1641
- <dd class="tag-source"><ul class="dummy"><li>
1642
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line414">line 414</a>
1643
- </li></ul></dd>
1640
+
1644
1641
 
1645
1642
 
1646
1643
 
@@ -1658,7 +1655,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1658
1655
 
1659
1656
 
1660
1657
 
1661
- <h5>Parameters:</h5>
1658
+
1659
+
1660
+ <h5 class="h5-examples">Example</h5>
1661
+
1662
+ <pre class="prettyprint"><code>fetchByRailContentId('abc123')
1663
+ .then(content => console.log(content))
1664
+ .catch(error => console.error(error));</code></pre>
1665
+
1666
+
1667
+
1668
+
1669
+ <h5 class="h5-parameters">Parameters:</h5>
1662
1670
 
1663
1671
 
1664
1672
  <table class="params">
@@ -1689,7 +1697,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1689
1697
  <td class="type">
1690
1698
 
1691
1699
 
1692
- <span class="param-type"><code>string</code></span>
1700
+ <span class="param-type">string</span>
1701
+
1693
1702
 
1694
1703
 
1695
1704
 
@@ -1699,10 +1708,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1699
1708
 
1700
1709
 
1701
1710
 
1702
- <td class="description last">
1703
- The Railcontent ID of the content to fetch.
1704
-
1705
- </td>
1711
+ <td class="description last">The Railcontent ID of the content to fetch.</td>
1706
1712
  </tr>
1707
1713
 
1708
1714
 
@@ -1722,59 +1728,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1722
1728
 
1723
1729
 
1724
1730
 
1725
- <div class="section-returns">
1726
- <h5>Returns:</h5>
1731
+
1732
+
1733
+ <h5 class="h5-returns">Returns:</h5>
1727
1734
 
1728
1735
 
1736
+ <div class="param-desc">
1737
+ - A promise that resolves to the content object or null if not found.
1738
+ </div>
1739
+
1740
+
1729
1741
 
1730
1742
  <dl class="param-type">
1731
1743
  <dt>
1732
- Type:
1744
+ Type
1733
1745
  </dt>
1734
1746
  <dd>
1735
1747
 
1736
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
1748
+ <span class="param-type">Promise.&lt;(Object|null)></span>
1749
+
1737
1750
 
1738
1751
 
1739
1752
  </dd>
1740
1753
  </dl>
1741
1754
 
1742
-
1743
- <div class="param-desc">
1744
- - The fetched content data or null if not found.
1745
- </div>
1746
-
1747
1755
 
1748
- </div>
1749
1756
 
1750
1757
 
1751
1758
 
1752
- </div>
1753
1759
 
1754
1760
 
1755
- <div class="section-method">
1756
1761
 
1757
1762
 
1758
1763
 
1759
- <h4 class="name" id="fetchByRailContentIds"><span class="type-signature">(async) </span>fetchByRailContentIds<span class="signature">(ids)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
1764
+ <h4 class="name" id="fetchByRailContentIds"><span class="type-signature type-signature-async">(async) </span>fetchByRailContentIds<span class="signature">(ids)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
1760
1765
 
1761
1766
 
1762
1767
 
1763
1768
 
1764
1769
 
1765
- <div class="description">
1766
- Fetch content by an array of Railcontent IDs.
1767
- </div>
1768
-
1769
-
1770
-
1771
-
1772
1770
 
1773
1771
  <dl class="details">
1774
-
1772
+
1773
+ <dt class="tag-description">Description:</dt>
1774
+ <dd class="tag-description"><ul class="dummy"><li>Fetch content by an array of Railcontent IDs.</li></ul></dd>
1775
1775
 
1776
1776
 
1777
1777
 
1778
+ <dt class="tag-source">Source:</dt>
1779
+ <dd class="tag-source"><ul class="dummy"><li>
1780
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line489">line 489</a>
1781
+ </li></ul></dd>
1782
+
1778
1783
 
1779
1784
 
1780
1785
 
@@ -1797,10 +1802,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1797
1802
 
1798
1803
 
1799
1804
 
1800
- <dt class="tag-source">Source:</dt>
1801
- <dd class="tag-source"><ul class="dummy"><li>
1802
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line434">line 434</a>
1803
- </li></ul></dd>
1805
+
1804
1806
 
1805
1807
 
1806
1808
 
@@ -1818,7 +1820,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1818
1820
 
1819
1821
 
1820
1822
 
1821
- <h5>Parameters:</h5>
1823
+
1824
+
1825
+ <h5 class="h5-examples">Example</h5>
1826
+
1827
+ <pre class="prettyprint"><code>fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
1828
+ .then(contents => console.log(contents))
1829
+ .catch(error => console.error(error));</code></pre>
1830
+
1831
+
1832
+
1833
+
1834
+ <h5 class="h5-parameters">Parameters:</h5>
1822
1835
 
1823
1836
 
1824
1837
  <table class="params">
@@ -1849,7 +1862,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1849
1862
  <td class="type">
1850
1863
 
1851
1864
 
1852
- <span class="param-type"><code>Array.&lt;string></code></span>
1865
+ <span class="param-type">Array.&lt;string></span>
1866
+
1853
1867
 
1854
1868
 
1855
1869
 
@@ -1859,10 +1873,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1859
1873
 
1860
1874
 
1861
1875
 
1862
- <td class="description last">
1863
- The array of Railcontent IDs of the content to fetch.
1864
-
1865
- </td>
1876
+ <td class="description last">The array of Railcontent IDs of the content to fetch.</td>
1866
1877
  </tr>
1867
1878
 
1868
1879
 
@@ -1882,59 +1893,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1882
1893
 
1883
1894
 
1884
1895
 
1885
- <div class="section-returns">
1886
- <h5>Returns:</h5>
1896
+
1897
+
1898
+ <h5 class="h5-returns">Returns:</h5>
1887
1899
 
1888
1900
 
1901
+ <div class="param-desc">
1902
+ - A promise that resolves to an array of content objects or null if not found.
1903
+ </div>
1904
+
1905
+
1889
1906
 
1890
1907
  <dl class="param-type">
1891
1908
  <dt>
1892
- Type:
1909
+ Type
1893
1910
  </dt>
1894
1911
  <dd>
1895
1912
 
1896
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
1913
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
1914
+
1897
1915
 
1898
1916
 
1899
1917
  </dd>
1900
1918
  </dl>
1901
1919
 
1902
-
1903
- <div class="param-desc">
1904
- - The fetched content data or null if not found.
1905
- </div>
1906
-
1907
1920
 
1908
- </div>
1909
1921
 
1910
1922
 
1911
1923
 
1912
- </div>
1913
1924
 
1914
1925
 
1915
- <div class="section-method">
1916
1926
 
1917
1927
 
1918
1928
 
1919
- <h4 class="name" id="fetchChildren"><span class="type-signature">(async) </span>fetchChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
1929
+ <h4 class="name" id="fetchChildren"><span class="type-signature type-signature-async">(async) </span>fetchChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
1920
1930
 
1921
1931
 
1922
1932
 
1923
1933
 
1924
1934
 
1925
- <div class="description">
1926
- Fetch children content by Railcontent ID.
1927
- </div>
1928
-
1929
-
1930
-
1931
-
1932
1935
 
1933
1936
  <dl class="details">
1934
-
1937
+
1938
+ <dt class="tag-description">Description:</dt>
1939
+ <dd class="tag-description"><ul class="dummy"><li>Fetch children content by Railcontent ID.</li></ul></dd>
1935
1940
 
1936
1941
 
1937
1942
 
1943
+ <dt class="tag-source">Source:</dt>
1944
+ <dd class="tag-source"><ul class="dummy"><li>
1945
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line716">line 716</a>
1946
+ </li></ul></dd>
1947
+
1938
1948
 
1939
1949
 
1940
1950
 
@@ -1957,10 +1967,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1957
1967
 
1958
1968
 
1959
1969
 
1960
- <dt class="tag-source">Source:</dt>
1961
- <dd class="tag-source"><ul class="dummy"><li>
1962
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line649">line 649</a>
1963
- </li></ul></dd>
1970
+
1964
1971
 
1965
1972
 
1966
1973
 
@@ -1978,7 +1985,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
1978
1985
 
1979
1986
 
1980
1987
 
1981
- <h5>Parameters:</h5>
1988
+
1989
+
1990
+
1991
+
1992
+ <h5 class="h5-parameters">Parameters:</h5>
1982
1993
 
1983
1994
 
1984
1995
  <table class="params">
@@ -2009,7 +2020,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2009
2020
  <td class="type">
2010
2021
 
2011
2022
 
2012
- <span class="param-type"><code>string</code></span>
2023
+ <span class="param-type">string</span>
2024
+
2013
2025
 
2014
2026
 
2015
2027
 
@@ -2019,10 +2031,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2019
2031
 
2020
2032
 
2021
2033
 
2022
- <td class="description last">
2023
- The Railcontent ID of the parent content.
2024
-
2025
- </td>
2034
+ <td class="description last">The Railcontent ID of the parent content.</td>
2026
2035
  </tr>
2027
2036
 
2028
2037
 
@@ -2042,59 +2051,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2042
2051
 
2043
2052
 
2044
2053
 
2045
- <div class="section-returns">
2046
- <h5>Returns:</h5>
2054
+
2055
+
2056
+ <h5 class="h5-returns">Returns:</h5>
2047
2057
 
2048
2058
 
2059
+ <div class="param-desc">
2060
+ - The fetched children content data or null if not found.
2061
+ </div>
2062
+
2063
+
2049
2064
 
2050
2065
  <dl class="param-type">
2051
2066
  <dt>
2052
- Type:
2067
+ Type
2053
2068
  </dt>
2054
2069
  <dd>
2055
2070
 
2056
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
2071
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
2072
+
2057
2073
 
2058
2074
 
2059
2075
  </dd>
2060
2076
  </dl>
2061
2077
 
2062
-
2063
- <div class="param-desc">
2064
- - The fetched children content data or null if not found.
2065
- </div>
2066
-
2067
2078
 
2068
- </div>
2069
2079
 
2070
2080
 
2071
2081
 
2072
- </div>
2073
2082
 
2074
2083
 
2075
- <div class="section-method">
2076
2084
 
2077
2085
 
2078
2086
 
2079
- <h4 class="name" id="fetchLessonContent"><span class="type-signature">(async) </span>fetchLessonContent<span class="signature">(railContentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2087
+ <h4 class="name" id="fetchLessonContent"><span class="type-signature type-signature-async">(async) </span>fetchLessonContent<span class="signature">(railContentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2080
2088
 
2081
2089
 
2082
2090
 
2083
2091
 
2084
2092
 
2085
- <div class="description">
2086
- Fetch the page data for a specific lesson by Railcontent ID.
2087
- </div>
2088
-
2089
-
2090
-
2091
-
2092
2093
 
2093
2094
  <dl class="details">
2094
-
2095
+
2096
+ <dt class="tag-description">Description:</dt>
2097
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the page data for a specific lesson by Railcontent ID.</li></ul></dd>
2095
2098
 
2096
2099
 
2097
2100
 
2101
+ <dt class="tag-source">Source:</dt>
2102
+ <dd class="tag-source"><ul class="dummy"><li>
2103
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line794">line 794</a>
2104
+ </li></ul></dd>
2105
+
2098
2106
 
2099
2107
 
2100
2108
 
@@ -2117,10 +2125,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2117
2125
 
2118
2126
 
2119
2127
 
2120
- <dt class="tag-source">Source:</dt>
2121
- <dd class="tag-source"><ul class="dummy"><li>
2122
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line722">line 722</a>
2123
- </li></ul></dd>
2128
+
2124
2129
 
2125
2130
 
2126
2131
 
@@ -2138,7 +2143,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2138
2143
 
2139
2144
 
2140
2145
 
2141
- <h5>Parameters:</h5>
2146
+
2147
+
2148
+ <h5 class="h5-examples">Example</h5>
2149
+
2150
+ <pre class="prettyprint"><code>fetchLessonContent('lesson123')
2151
+ .then(data => console.log(data))
2152
+ .catch(error => console.error(error));</code></pre>
2153
+
2154
+
2155
+
2156
+
2157
+ <h5 class="h5-parameters">Parameters:</h5>
2142
2158
 
2143
2159
 
2144
2160
  <table class="params">
@@ -2169,7 +2185,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2169
2185
  <td class="type">
2170
2186
 
2171
2187
 
2172
- <span class="param-type"><code>string</code></span>
2188
+ <span class="param-type">string</span>
2189
+
2173
2190
 
2174
2191
 
2175
2192
 
@@ -2179,10 +2196,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2179
2196
 
2180
2197
 
2181
2198
 
2182
- <td class="description last">
2183
- The Railcontent ID of the current lesson.
2184
-
2185
- </td>
2199
+ <td class="description last">The Railcontent ID of the current lesson.</td>
2186
2200
  </tr>
2187
2201
 
2188
2202
 
@@ -2202,59 +2216,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2202
2216
 
2203
2217
 
2204
2218
 
2205
- <div class="section-returns">
2206
- <h5>Returns:</h5>
2219
+
2220
+
2221
+ <h5 class="h5-returns">Returns:</h5>
2207
2222
 
2208
2223
 
2224
+ <div class="param-desc">
2225
+ - The fetched page data or null if found.
2226
+ </div>
2227
+
2228
+
2209
2229
 
2210
2230
  <dl class="param-type">
2211
2231
  <dt>
2212
- Type:
2232
+ Type
2213
2233
  </dt>
2214
2234
  <dd>
2215
2235
 
2216
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
2236
+ <span class="param-type">Promise.&lt;(Object|null)></span>
2237
+
2217
2238
 
2218
2239
 
2219
2240
  </dd>
2220
2241
  </dl>
2221
2242
 
2222
-
2223
- <div class="param-desc">
2224
- - The fetched page data or null if found.
2225
- </div>
2226
-
2227
2243
 
2228
- </div>
2229
2244
 
2230
2245
 
2231
2246
 
2232
- </div>
2233
2247
 
2234
2248
 
2235
- <div class="section-method">
2236
2249
 
2237
2250
 
2238
2251
 
2239
- <h4 class="name" id="fetchMethodChildren"><span class="type-signature">(async) </span>fetchMethodChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
2252
+ <h4 class="name" id="fetchMethodChildren"><span class="type-signature type-signature-async">(async) </span>fetchMethodChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
2240
2253
 
2241
2254
 
2242
2255
 
2243
2256
 
2244
2257
 
2245
- <div class="description">
2246
- Fetch all children of a specific method by Railcontent ID.
2247
- </div>
2248
-
2249
-
2250
-
2251
-
2252
2258
 
2253
2259
  <dl class="details">
2254
-
2260
+
2261
+ <dt class="tag-description">Description:</dt>
2262
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all children of a specific method by Railcontent ID.</li></ul></dd>
2255
2263
 
2256
2264
 
2257
2265
 
2266
+ <dt class="tag-source">Source:</dt>
2267
+ <dd class="tag-source"><ul class="dummy"><li>
2268
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line758">line 758</a>
2269
+ </li></ul></dd>
2270
+
2258
2271
 
2259
2272
 
2260
2273
 
@@ -2277,10 +2290,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2277
2290
 
2278
2291
 
2279
2292
 
2280
- <dt class="tag-source">Source:</dt>
2281
- <dd class="tag-source"><ul class="dummy"><li>
2282
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line691">line 691</a>
2283
- </li></ul></dd>
2293
+
2284
2294
 
2285
2295
 
2286
2296
 
@@ -2298,7 +2308,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2298
2308
 
2299
2309
 
2300
2310
 
2301
- <h5>Parameters:</h5>
2311
+
2312
+
2313
+
2314
+
2315
+ <h5 class="h5-parameters">Parameters:</h5>
2302
2316
 
2303
2317
 
2304
2318
  <table class="params">
@@ -2329,7 +2343,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2329
2343
  <td class="type">
2330
2344
 
2331
2345
 
2332
- <span class="param-type"><code>string</code></span>
2346
+ <span class="param-type">string</span>
2347
+
2333
2348
 
2334
2349
 
2335
2350
 
@@ -2339,10 +2354,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2339
2354
 
2340
2355
 
2341
2356
 
2342
- <td class="description last">
2343
- The Railcontent ID of the method.
2344
-
2345
- </td>
2357
+ <td class="description last">The Railcontent ID of the method.</td>
2346
2358
  </tr>
2347
2359
 
2348
2360
 
@@ -2362,59 +2374,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2362
2374
 
2363
2375
 
2364
2376
 
2365
- <div class="section-returns">
2366
- <h5>Returns:</h5>
2377
+
2378
+
2379
+ <h5 class="h5-returns">Returns:</h5>
2367
2380
 
2368
2381
 
2382
+ <div class="param-desc">
2383
+ - The fetched children data or null if not found.
2384
+ </div>
2385
+
2386
+
2369
2387
 
2370
2388
  <dl class="param-type">
2371
2389
  <dt>
2372
- Type:
2390
+ Type
2373
2391
  </dt>
2374
2392
  <dd>
2375
2393
 
2376
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
2394
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
2395
+
2377
2396
 
2378
2397
 
2379
2398
  </dd>
2380
2399
  </dl>
2381
2400
 
2382
-
2383
- <div class="param-desc">
2384
- - The fetched children data or null if not found.
2385
- </div>
2386
-
2387
2401
 
2388
- </div>
2389
2402
 
2390
2403
 
2391
2404
 
2392
- </div>
2393
2405
 
2394
2406
 
2395
- <div class="section-method">
2396
2407
 
2397
2408
 
2398
2409
 
2399
- <h4 class="name" id="fetchMethodNextLesson"><span class="type-signature">(async) </span>fetchMethodNextLesson<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2410
+ <h4 class="name" id="fetchMethodNextLesson"><span class="type-signature type-signature-async">(async) </span>fetchMethodNextLesson<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2400
2411
 
2401
2412
 
2402
2413
 
2403
2414
 
2404
2415
 
2405
- <div class="description">
2406
- Fetch the next lesson for a specific method by Railcontent ID.
2407
- </div>
2408
-
2409
-
2410
-
2411
-
2412
2416
 
2413
2417
  <dl class="details">
2414
-
2418
+
2419
+ <dt class="tag-description">Description:</dt>
2420
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the next lesson for a specific method by Railcontent ID.</li></ul></dd>
2415
2421
 
2416
2422
 
2417
2423
 
2424
+ <dt class="tag-source">Source:</dt>
2425
+ <dd class="tag-source"><ul class="dummy"><li>
2426
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line737">line 737</a>
2427
+ </li></ul></dd>
2428
+
2418
2429
 
2419
2430
 
2420
2431
 
@@ -2437,10 +2448,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2437
2448
 
2438
2449
 
2439
2450
 
2440
- <dt class="tag-source">Source:</dt>
2441
- <dd class="tag-source"><ul class="dummy"><li>
2442
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line670">line 670</a>
2443
- </li></ul></dd>
2451
+
2444
2452
 
2445
2453
 
2446
2454
 
@@ -2458,7 +2466,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2458
2466
 
2459
2467
 
2460
2468
 
2461
- <h5>Parameters:</h5>
2469
+
2470
+
2471
+
2472
+
2473
+ <h5 class="h5-parameters">Parameters:</h5>
2462
2474
 
2463
2475
 
2464
2476
  <table class="params">
@@ -2489,7 +2501,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2489
2501
  <td class="type">
2490
2502
 
2491
2503
 
2492
- <span class="param-type"><code>string</code></span>
2504
+ <span class="param-type">string</span>
2505
+
2493
2506
 
2494
2507
 
2495
2508
 
@@ -2499,10 +2512,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2499
2512
 
2500
2513
 
2501
2514
 
2502
- <td class="description last">
2503
- The Railcontent ID of the current lesson.
2504
-
2505
- </td>
2515
+ <td class="description last">The Railcontent ID of the current lesson.</td>
2506
2516
  </tr>
2507
2517
 
2508
2518
 
@@ -2522,59 +2532,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2522
2532
 
2523
2533
 
2524
2534
 
2525
- <div class="section-returns">
2526
- <h5>Returns:</h5>
2535
+
2536
+
2537
+ <h5 class="h5-returns">Returns:</h5>
2527
2538
 
2528
2539
 
2540
+ <div class="param-desc">
2541
+ - The fetched next lesson data or null if not found.
2542
+ </div>
2543
+
2544
+
2529
2545
 
2530
2546
  <dl class="param-type">
2531
2547
  <dt>
2532
- Type:
2548
+ Type
2533
2549
  </dt>
2534
2550
  <dd>
2535
2551
 
2536
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
2552
+ <span class="param-type">Promise.&lt;(Object|null)></span>
2553
+
2537
2554
 
2538
2555
 
2539
2556
  </dd>
2540
2557
  </dl>
2541
2558
 
2542
-
2543
- <div class="param-desc">
2544
- - The fetched next lesson data or null if not found.
2545
- </div>
2546
-
2547
2559
 
2548
- </div>
2549
2560
 
2550
2561
 
2551
2562
 
2552
- </div>
2553
2563
 
2554
2564
 
2555
- <div class="section-method">
2556
2565
 
2557
2566
 
2558
2567
 
2559
- <h4 class="name" id="fetchNewReleases"><span class="type-signature">(async) </span>fetchNewReleases<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2568
+ <h4 class="name" id="fetchNewReleases"><span class="type-signature type-signature-async">(async) </span>fetchNewReleases<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2560
2569
 
2561
2570
 
2562
2571
 
2563
2572
 
2564
2573
 
2565
- <div class="description">
2566
- Fetch the latest new releases for a specific brand.
2567
- </div>
2568
-
2569
-
2570
-
2571
-
2572
2574
 
2573
2575
  <dl class="details">
2574
-
2576
+
2577
+ <dt class="tag-description">Description:</dt>
2578
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the latest new releases for a specific brand.</li></ul></dd>
2575
2579
 
2576
2580
 
2577
2581
 
2582
+ <dt class="tag-source">Source:</dt>
2583
+ <dd class="tag-source"><ul class="dummy"><li>
2584
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line393">line 393</a>
2585
+ </li></ul></dd>
2586
+
2578
2587
 
2579
2588
 
2580
2589
 
@@ -2597,10 +2606,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2597
2606
 
2598
2607
 
2599
2608
 
2600
- <dt class="tag-source">Source:</dt>
2601
- <dd class="tag-source"><ul class="dummy"><li>
2602
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line356">line 356</a>
2603
- </li></ul></dd>
2609
+
2604
2610
 
2605
2611
 
2606
2612
 
@@ -2618,7 +2624,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2618
2624
 
2619
2625
 
2620
2626
 
2621
- <h5>Parameters:</h5>
2627
+
2628
+
2629
+
2630
+
2631
+ <h5 class="h5-parameters">Parameters:</h5>
2622
2632
 
2623
2633
 
2624
2634
  <table class="params">
@@ -2649,7 +2659,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2649
2659
  <td class="type">
2650
2660
 
2651
2661
 
2652
- <span class="param-type"><code>string</code></span>
2662
+ <span class="param-type">string</span>
2663
+
2653
2664
 
2654
2665
 
2655
2666
 
@@ -2659,10 +2670,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2659
2670
 
2660
2671
 
2661
2672
 
2662
- <td class="description last">
2663
- The brand for which to fetch new releases.
2664
-
2665
- </td>
2673
+ <td class="description last">The brand for which to fetch new releases.</td>
2666
2674
  </tr>
2667
2675
 
2668
2676
 
@@ -2682,59 +2690,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2682
2690
 
2683
2691
 
2684
2692
 
2685
- <div class="section-returns">
2686
- <h5>Returns:</h5>
2687
2693
 
2688
-
2694
+
2695
+ <h5 class="h5-returns">Returns:</h5>
2696
+
2697
+
2698
+ <div class="param-desc">
2699
+ - The fetched new releases data or null if not found.
2700
+ </div>
2701
+
2702
+
2689
2703
 
2690
2704
  <dl class="param-type">
2691
2705
  <dt>
2692
- Type:
2706
+ Type
2693
2707
  </dt>
2694
2708
  <dd>
2695
2709
 
2696
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
2710
+ <span class="param-type">Promise.&lt;(Object|null)></span>
2711
+
2697
2712
 
2698
2713
 
2699
2714
  </dd>
2700
2715
  </dl>
2701
2716
 
2702
-
2703
- <div class="param-desc">
2704
- - The fetched new releases data or null if not found.
2705
- </div>
2706
-
2707
2717
 
2708
- </div>
2709
2718
 
2710
2719
 
2711
2720
 
2712
- </div>
2713
2721
 
2714
2722
 
2715
- <div class="section-method">
2716
2723
 
2717
2724
 
2718
2725
 
2719
- <h4 class="name" id="fetchNextPreviousLesson"><span class="type-signature">(async) </span>fetchNextPreviousLesson<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2726
+ <h4 class="name" id="fetchNextPreviousLesson"><span class="type-signature type-signature-async">(async) </span>fetchNextPreviousLesson<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2720
2727
 
2721
2728
 
2722
2729
 
2723
2730
 
2724
2731
 
2725
- <div class="description">
2726
- Fetch the next and previous lessons for a specific lesson by Railcontent ID.
2727
- </div>
2728
-
2729
-
2730
-
2731
-
2732
2732
 
2733
2733
  <dl class="details">
2734
-
2734
+
2735
+ <dt class="tag-description">Description:</dt>
2736
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the next and previous lessons for a specific lesson by Railcontent ID.</li></ul></dd>
2735
2737
 
2736
2738
 
2737
2739
 
2740
+ <dt class="tag-source">Source:</dt>
2741
+ <dd class="tag-source"><ul class="dummy"><li>
2742
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line768">line 768</a>
2743
+ </li></ul></dd>
2744
+
2738
2745
 
2739
2746
 
2740
2747
 
@@ -2757,10 +2764,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2757
2764
 
2758
2765
 
2759
2766
 
2760
- <dt class="tag-source">Source:</dt>
2761
- <dd class="tag-source"><ul class="dummy"><li>
2762
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line701">line 701</a>
2763
- </li></ul></dd>
2767
+
2764
2768
 
2765
2769
 
2766
2770
 
@@ -2778,7 +2782,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2778
2782
 
2779
2783
 
2780
2784
 
2781
- <h5>Parameters:</h5>
2785
+
2786
+
2787
+
2788
+
2789
+ <h5 class="h5-parameters">Parameters:</h5>
2782
2790
 
2783
2791
 
2784
2792
  <table class="params">
@@ -2809,7 +2817,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2809
2817
  <td class="type">
2810
2818
 
2811
2819
 
2812
- <span class="param-type"><code>string</code></span>
2820
+ <span class="param-type">string</span>
2821
+
2813
2822
 
2814
2823
 
2815
2824
 
@@ -2819,10 +2828,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2819
2828
 
2820
2829
 
2821
2830
 
2822
- <td class="description last">
2823
- The Railcontent ID of the current lesson.
2824
-
2825
- </td>
2831
+ <td class="description last">The Railcontent ID of the current lesson.</td>
2826
2832
  </tr>
2827
2833
 
2828
2834
 
@@ -2842,59 +2848,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2842
2848
 
2843
2849
 
2844
2850
 
2845
- <div class="section-returns">
2846
- <h5>Returns:</h5>
2851
+
2852
+
2853
+ <h5 class="h5-returns">Returns:</h5>
2847
2854
 
2848
2855
 
2856
+ <div class="param-desc">
2857
+ - The fetched next and previous lesson data or null if found.
2858
+ </div>
2859
+
2860
+
2849
2861
 
2850
2862
  <dl class="param-type">
2851
2863
  <dt>
2852
- Type:
2864
+ Type
2853
2865
  </dt>
2854
2866
  <dd>
2855
2867
 
2856
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
2868
+ <span class="param-type">Promise.&lt;(Object|null)></span>
2869
+
2857
2870
 
2858
2871
 
2859
2872
  </dd>
2860
2873
  </dl>
2861
2874
 
2862
-
2863
- <div class="param-desc">
2864
- - The fetched next and previous lesson data or null if found.
2865
- </div>
2866
-
2867
2875
 
2868
- </div>
2869
2876
 
2870
2877
 
2871
2878
 
2872
- </div>
2873
2879
 
2874
2880
 
2875
- <div class="section-method">
2876
2881
 
2877
2882
 
2878
2883
 
2879
- <h4 class="name" id="fetchPackAll"><span class="type-signature">(async) </span>fetchPackAll<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
2884
+ <h4 class="name" id="fetchPackAll"><span class="type-signature type-signature-async">(async) </span>fetchPackAll<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
2880
2885
 
2881
2886
 
2882
2887
 
2883
2888
 
2884
2889
 
2885
- <div class="description">
2886
- Fetch all content for a specific pack by Railcontent ID.
2887
- </div>
2888
-
2889
-
2890
-
2891
-
2892
2890
 
2893
2891
  <dl class="details">
2894
-
2892
+
2893
+ <dt class="tag-description">Description:</dt>
2894
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all content for a specific pack by Railcontent ID.</li></ul></dd>
2895
2895
 
2896
2896
 
2897
2897
 
2898
+ <dt class="tag-source">Source:</dt>
2899
+ <dd class="tag-source"><ul class="dummy"><li>
2900
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line848">line 848</a>
2901
+ </li></ul></dd>
2902
+
2898
2903
 
2899
2904
 
2900
2905
 
@@ -2917,10 +2922,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2917
2922
 
2918
2923
 
2919
2924
 
2920
- <dt class="tag-source">Source:</dt>
2921
- <dd class="tag-source"><ul class="dummy"><li>
2922
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a>
2923
- </li></ul></dd>
2925
+
2924
2926
 
2925
2927
 
2926
2928
 
@@ -2938,7 +2940,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2938
2940
 
2939
2941
 
2940
2942
 
2941
- <h5>Parameters:</h5>
2943
+
2944
+
2945
+
2946
+
2947
+ <h5 class="h5-parameters">Parameters:</h5>
2942
2948
 
2943
2949
 
2944
2950
  <table class="params">
@@ -2969,7 +2975,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2969
2975
  <td class="type">
2970
2976
 
2971
2977
 
2972
- <span class="param-type"><code>string</code></span>
2978
+ <span class="param-type">string</span>
2979
+
2973
2980
 
2974
2981
 
2975
2982
 
@@ -2979,10 +2986,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
2979
2986
 
2980
2987
 
2981
2988
 
2982
- <td class="description last">
2983
- The Railcontent ID of the pack.
2984
-
2985
- </td>
2989
+ <td class="description last">The Railcontent ID of the pack.</td>
2986
2990
  </tr>
2987
2991
 
2988
2992
 
@@ -3002,59 +3006,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3002
3006
 
3003
3007
 
3004
3008
 
3005
- <div class="section-returns">
3006
- <h5>Returns:</h5>
3009
+
3010
+
3011
+ <h5 class="h5-returns">Returns:</h5>
3007
3012
 
3008
3013
 
3014
+ <div class="param-desc">
3015
+ - The fetched pack content data or null if not found.
3016
+ </div>
3017
+
3018
+
3009
3019
 
3010
3020
  <dl class="param-type">
3011
3021
  <dt>
3012
- Type:
3022
+ Type
3013
3023
  </dt>
3014
3024
  <dd>
3015
3025
 
3016
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
3026
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
3027
+
3017
3028
 
3018
3029
 
3019
3030
  </dd>
3020
3031
  </dl>
3021
3032
 
3022
-
3023
- <div class="param-desc">
3024
- - The fetched pack content data or null if not found.
3025
- </div>
3026
-
3027
3033
 
3028
- </div>
3029
3034
 
3030
3035
 
3031
3036
 
3032
- </div>
3033
3037
 
3034
3038
 
3035
- <div class="section-method">
3036
3039
 
3037
3040
 
3038
3041
 
3039
- <h4 class="name" id="fetchPackChildren"><span class="type-signature">(async) </span>fetchPackChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
3042
+ <h4 class="name" id="fetchPackChildren"><span class="type-signature type-signature-async">(async) </span>fetchPackChildren<span class="signature">(railcontentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
3040
3043
 
3041
3044
 
3042
3045
 
3043
3046
 
3044
3047
 
3045
- <div class="description">
3046
- Fetch all children of a specific pack by Railcontent ID.
3047
- </div>
3048
-
3049
-
3050
-
3051
-
3052
3048
 
3053
3049
  <dl class="details">
3054
-
3050
+
3051
+ <dt class="tag-description">Description:</dt>
3052
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all children of a specific pack by Railcontent ID.</li></ul></dd>
3055
3053
 
3056
3054
 
3057
3055
 
3056
+ <dt class="tag-source">Source:</dt>
3057
+ <dd class="tag-source"><ul class="dummy"><li>
3058
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line874">line 874</a>
3059
+ </li></ul></dd>
3060
+
3058
3061
 
3059
3062
 
3060
3063
 
@@ -3077,10 +3080,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3077
3080
 
3078
3081
 
3079
3082
 
3080
- <dt class="tag-source">Source:</dt>
3081
- <dd class="tag-source"><ul class="dummy"><li>
3082
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line797">line 797</a>
3083
- </li></ul></dd>
3083
+
3084
3084
 
3085
3085
 
3086
3086
 
@@ -3098,7 +3098,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3098
3098
 
3099
3099
 
3100
3100
 
3101
- <h5>Parameters:</h5>
3101
+
3102
+
3103
+ <h5 class="h5-examples">Example</h5>
3104
+
3105
+ <pre class="prettyprint"><code>fetchPackChildren('pack123')
3106
+ .then(children => console.log(children))
3107
+ .catch(error => console.error(error));</code></pre>
3108
+
3109
+
3110
+
3111
+
3112
+ <h5 class="h5-parameters">Parameters:</h5>
3102
3113
 
3103
3114
 
3104
3115
  <table class="params">
@@ -3129,7 +3140,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3129
3140
  <td class="type">
3130
3141
 
3131
3142
 
3132
- <span class="param-type"><code>string</code></span>
3143
+ <span class="param-type">string</span>
3144
+
3133
3145
 
3134
3146
 
3135
3147
 
@@ -3139,10 +3151,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3139
3151
 
3140
3152
 
3141
3153
 
3142
- <td class="description last">
3143
- The Railcontent ID of the pack.
3144
-
3145
- </td>
3154
+ <td class="description last">The Railcontent ID of the pack.</td>
3146
3155
  </tr>
3147
3156
 
3148
3157
 
@@ -3162,59 +3171,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3162
3171
 
3163
3172
 
3164
3173
 
3165
- <div class="section-returns">
3166
- <h5>Returns:</h5>
3174
+
3175
+
3176
+ <h5 class="h5-returns">Returns:</h5>
3167
3177
 
3168
3178
 
3179
+ <div class="param-desc">
3180
+ - The fetched pack children data or null if not found.
3181
+ </div>
3182
+
3183
+
3169
3184
 
3170
3185
  <dl class="param-type">
3171
3186
  <dt>
3172
- Type:
3187
+ Type
3173
3188
  </dt>
3174
3189
  <dd>
3175
3190
 
3176
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
3191
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
3192
+
3177
3193
 
3178
3194
 
3179
3195
  </dd>
3180
3196
  </dl>
3181
3197
 
3182
-
3183
- <div class="param-desc">
3184
- - The fetched pack children data or null if not found.
3185
- </div>
3186
-
3187
3198
 
3188
- </div>
3189
3199
 
3190
3200
 
3191
3201
 
3192
- </div>
3193
3202
 
3194
3203
 
3195
- <div class="section-method">
3196
3204
 
3197
3205
 
3198
3206
 
3199
- <h4 class="name" id="fetchRelatedLessons"><span class="type-signature">(async) </span>fetchRelatedLessons<span class="signature">(railContentId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
3207
+ <h4 class="name" id="fetchRelatedLessons"><span class="type-signature type-signature-async">(async) </span>fetchRelatedLessons<span class="signature">(railContentId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
3200
3208
 
3201
3209
 
3202
3210
 
3203
3211
 
3204
3212
 
3205
- <div class="description">
3206
- Fetch related lessons for a specific lesson by RailContent ID and type.
3207
- </div>
3208
-
3209
-
3210
-
3211
-
3212
3213
 
3213
3214
  <dl class="details">
3214
-
3215
+
3216
+ <dt class="tag-description">Description:</dt>
3217
+ <dd class="tag-description"><ul class="dummy"><li>Fetch related lessons for a specific lesson by RailContent ID and type.</li></ul></dd>
3215
3218
 
3216
3219
 
3217
3220
 
3221
+ <dt class="tag-source">Source:</dt>
3222
+ <dd class="tag-source"><ul class="dummy"><li>
3223
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line827">line 827</a>
3224
+ </li></ul></dd>
3225
+
3218
3226
 
3219
3227
 
3220
3228
 
@@ -3237,10 +3245,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3237
3245
 
3238
3246
 
3239
3247
 
3240
- <dt class="tag-source">Source:</dt>
3241
- <dd class="tag-source"><ul class="dummy"><li>
3242
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line755">line 755</a>
3243
- </li></ul></dd>
3248
+
3244
3249
 
3245
3250
 
3246
3251
 
@@ -3258,7 +3263,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3258
3263
 
3259
3264
 
3260
3265
 
3261
- <h5>Parameters:</h5>
3266
+
3267
+
3268
+
3269
+
3270
+ <h5 class="h5-parameters">Parameters:</h5>
3262
3271
 
3263
3272
 
3264
3273
  <table class="params">
@@ -3289,7 +3298,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3289
3298
  <td class="type">
3290
3299
 
3291
3300
 
3292
- <span class="param-type"><code>string</code></span>
3301
+ <span class="param-type">string</span>
3302
+
3293
3303
 
3294
3304
 
3295
3305
 
@@ -3299,10 +3309,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3299
3309
 
3300
3310
 
3301
3311
 
3302
- <td class="description last">
3303
- The RailContent ID of the current lesson.
3304
-
3305
- </td>
3312
+ <td class="description last">The RailContent ID of the current lesson.</td>
3306
3313
  </tr>
3307
3314
 
3308
3315
 
@@ -3315,7 +3322,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3315
3322
  <td class="type">
3316
3323
 
3317
3324
 
3318
- <span class="param-type"><code>string</code></span>
3325
+ <span class="param-type">string</span>
3326
+
3319
3327
 
3320
3328
 
3321
3329
 
@@ -3325,10 +3333,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3325
3333
 
3326
3334
 
3327
3335
 
3328
- <td class="description last">
3329
- The current brand.
3330
-
3331
- </td>
3336
+ <td class="description last">The current brand.</td>
3332
3337
  </tr>
3333
3338
 
3334
3339
 
@@ -3348,59 +3353,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3348
3353
 
3349
3354
 
3350
3355
 
3351
- <div class="section-returns">
3352
- <h5>Returns:</h5>
3356
+
3357
+
3358
+ <h5 class="h5-returns">Returns:</h5>
3353
3359
 
3354
3360
 
3361
+ <div class="param-desc">
3362
+ - The fetched related lessons data or null if not found.
3363
+ </div>
3364
+
3365
+
3355
3366
 
3356
3367
  <dl class="param-type">
3357
3368
  <dt>
3358
- Type:
3369
+ Type
3359
3370
  </dt>
3360
3371
  <dd>
3361
3372
 
3362
- <span class="param-type"><code>Promise.&lt;(Array.&lt;Object>|null)></code></span>
3373
+ <span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
3374
+
3363
3375
 
3364
3376
 
3365
3377
  </dd>
3366
3378
  </dl>
3367
3379
 
3368
-
3369
- <div class="param-desc">
3370
- - The fetched related lessons data or null if not found.
3371
- </div>
3372
-
3373
3380
 
3374
- </div>
3375
3381
 
3376
3382
 
3377
3383
 
3378
- </div>
3379
3384
 
3380
3385
 
3381
- <div class="section-method">
3382
3386
 
3383
3387
 
3384
3388
 
3385
- <h4 class="name" id="fetchRelatedSongs"><span class="type-signature">(async) </span>fetchRelatedSongs<span class="signature">(brand, songId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3389
+ <h4 class="name" id="fetchRelatedSongs"><span class="type-signature type-signature-async">(async) </span>fetchRelatedSongs<span class="signature">(brand, songId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3386
3390
 
3387
3391
 
3388
3392
 
3389
3393
 
3390
3394
 
3391
- <div class="description">
3392
- Fetch related songs for a specific brand and song ID.
3393
- </div>
3394
-
3395
-
3396
-
3397
-
3398
3395
 
3399
3396
  <dl class="details">
3400
-
3397
+
3398
+ <dt class="tag-description">Description:</dt>
3399
+ <dd class="tag-description"><ul class="dummy"><li>Fetch related songs for a specific brand and song ID.</li></ul></dd>
3401
3400
 
3402
3401
 
3403
3402
 
3403
+ <dt class="tag-source">Source:</dt>
3404
+ <dd class="tag-source"><ul class="dummy"><li>
3405
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line103">line 103</a>
3406
+ </li></ul></dd>
3407
+
3404
3408
 
3405
3409
 
3406
3410
 
@@ -3423,10 +3427,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3423
3427
 
3424
3428
 
3425
3429
 
3426
- <dt class="tag-source">Source:</dt>
3427
- <dd class="tag-source"><ul class="dummy"><li>
3428
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
3429
- </li></ul></dd>
3430
+
3430
3431
 
3431
3432
 
3432
3433
 
@@ -3444,7 +3445,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3444
3445
 
3445
3446
 
3446
3447
 
3447
- <h5>Parameters:</h5>
3448
+
3449
+
3450
+ <h5 class="h5-examples">Example</h5>
3451
+
3452
+ <pre class="prettyprint"><code>fetchRelatedSongs('drumeo', '12345')
3453
+ .then(relatedSongs => console.log(relatedSongs))
3454
+ .catch(error => console.error(error));</code></pre>
3455
+
3456
+
3457
+
3458
+
3459
+ <h5 class="h5-parameters">Parameters:</h5>
3448
3460
 
3449
3461
 
3450
3462
  <table class="params">
@@ -3475,7 +3487,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3475
3487
  <td class="type">
3476
3488
 
3477
3489
 
3478
- <span class="param-type"><code>string</code></span>
3490
+ <span class="param-type">string</span>
3491
+
3479
3492
 
3480
3493
 
3481
3494
 
@@ -3485,10 +3498,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3485
3498
 
3486
3499
 
3487
3500
 
3488
- <td class="description last">
3489
- The brand for which to fetch related songs.
3490
-
3491
- </td>
3501
+ <td class="description last">The brand for which to fetch related songs.</td>
3492
3502
  </tr>
3493
3503
 
3494
3504
 
@@ -3501,7 +3511,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3501
3511
  <td class="type">
3502
3512
 
3503
3513
 
3504
- <span class="param-type"><code>string</code></span>
3514
+ <span class="param-type">string</span>
3515
+
3505
3516
 
3506
3517
 
3507
3518
 
@@ -3511,10 +3522,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3511
3522
 
3512
3523
 
3513
3524
 
3514
- <td class="description last">
3515
- The ID of the song to find related songs for.
3516
-
3517
- </td>
3525
+ <td class="description last">The ID of the song to find related songs for.</td>
3518
3526
  </tr>
3519
3527
 
3520
3528
 
@@ -3534,59 +3542,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3534
3542
 
3535
3543
 
3536
3544
 
3537
- <div class="section-returns">
3538
- <h5>Returns:</h5>
3545
+
3546
+
3547
+ <h5 class="h5-returns">Returns:</h5>
3539
3548
 
3540
3549
 
3550
+ <div class="param-desc">
3551
+ - A promise that resolves to an array of related song objects or null if not found.
3552
+ </div>
3553
+
3554
+
3541
3555
 
3542
3556
  <dl class="param-type">
3543
3557
  <dt>
3544
- Type:
3558
+ Type
3545
3559
  </dt>
3546
3560
  <dd>
3547
3561
 
3548
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
3562
+ <span class="param-type">Promise.&lt;(Object|null)></span>
3563
+
3549
3564
 
3550
3565
 
3551
3566
  </dd>
3552
3567
  </dl>
3553
3568
 
3554
-
3555
- <div class="param-desc">
3556
- - The fetched related songs data or null if not found.
3557
- </div>
3558
-
3559
3569
 
3560
- </div>
3561
3570
 
3562
3571
 
3563
3572
 
3564
- </div>
3565
3573
 
3566
3574
 
3567
- <div class="section-method">
3568
3575
 
3569
3576
 
3570
3577
 
3571
- <h4 class="name" id="fetchSanity"><span class="type-signature">(async) </span>fetchSanity<span class="signature">(query, isList)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3578
+ <h4 class="name" id="fetchSanity"><span class="type-signature type-signature-async">(async) </span>fetchSanity<span class="signature">(query, isList)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3572
3579
 
3573
3580
 
3574
3581
 
3575
3582
 
3576
3583
 
3577
- <div class="description">
3578
- Fetch data from the Sanity API based on a provided query.
3579
- </div>
3580
-
3581
-
3582
-
3583
-
3584
3584
 
3585
3585
  <dl class="details">
3586
-
3586
+
3587
+ <dt class="tag-description">Description:</dt>
3588
+ <dd class="tag-description"><ul class="dummy"><li>Fetch data from the Sanity API based on a provided query.</li></ul></dd>
3587
3589
 
3588
3590
 
3589
3591
 
3592
+ <dt class="tag-source">Source:</dt>
3593
+ <dd class="tag-source"><ul class="dummy"><li>
3594
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line891">line 891</a>
3595
+ </li></ul></dd>
3596
+
3590
3597
 
3591
3598
 
3592
3599
 
@@ -3609,10 +3616,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3609
3616
 
3610
3617
 
3611
3618
 
3612
- <dt class="tag-source">Source:</dt>
3613
- <dd class="tag-source"><ul class="dummy"><li>
3614
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line807">line 807</a>
3615
- </li></ul></dd>
3619
+
3616
3620
 
3617
3621
 
3618
3622
 
@@ -3630,7 +3634,19 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3630
3634
 
3631
3635
 
3632
3636
 
3633
- <h5>Parameters:</h5>
3637
+
3638
+
3639
+ <h5 class="h5-examples">Example</h5>
3640
+
3641
+ <pre class="prettyprint"><code>const query = `*[_type == "song"]{title, artist->name}`;
3642
+ fetchSanity(query, true)
3643
+ .then(data => console.log(data))
3644
+ .catch(error => console.error(error));</code></pre>
3645
+
3646
+
3647
+
3648
+
3649
+ <h5 class="h5-parameters">Parameters:</h5>
3634
3650
 
3635
3651
 
3636
3652
  <table class="params">
@@ -3661,7 +3677,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3661
3677
  <td class="type">
3662
3678
 
3663
3679
 
3664
- <span class="param-type"><code>string</code></span>
3680
+ <span class="param-type">string</span>
3681
+
3665
3682
 
3666
3683
 
3667
3684
 
@@ -3671,10 +3688,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3671
3688
 
3672
3689
 
3673
3690
 
3674
- <td class="description last">
3675
- The GROQ query to execute against the Sanity API.
3676
-
3677
- </td>
3691
+ <td class="description last">The GROQ query to execute against the Sanity API.</td>
3678
3692
  </tr>
3679
3693
 
3680
3694
 
@@ -3687,7 +3701,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3687
3701
  <td class="type">
3688
3702
 
3689
3703
 
3690
- <span class="param-type"><code>boolean</code></span>
3704
+ <span class="param-type">boolean</span>
3705
+
3691
3706
 
3692
3707
 
3693
3708
 
@@ -3697,10 +3712,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3697
3712
 
3698
3713
 
3699
3714
 
3700
- <td class="description last">
3701
- Whether to return an array or single result
3702
-
3703
- </td>
3715
+ <td class="description last">Whether to return an array or a single result.</td>
3704
3716
  </tr>
3705
3717
 
3706
3718
 
@@ -3720,59 +3732,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3720
3732
 
3721
3733
 
3722
3734
 
3723
- <div class="section-returns">
3724
- <h5>Returns:</h5>
3735
+
3736
+
3737
+ <h5 class="h5-returns">Returns:</h5>
3725
3738
 
3726
3739
 
3740
+ <div class="param-desc">
3741
+ - A promise that resolves to the fetched data or null if an error occurs or no results are found.
3742
+ </div>
3743
+
3744
+
3727
3745
 
3728
3746
  <dl class="param-type">
3729
3747
  <dt>
3730
- Type:
3748
+ Type
3731
3749
  </dt>
3732
3750
  <dd>
3733
3751
 
3734
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
3752
+ <span class="param-type">Promise.&lt;(Object|null)></span>
3753
+
3735
3754
 
3736
3755
 
3737
3756
  </dd>
3738
3757
  </dl>
3739
3758
 
3740
-
3741
- <div class="param-desc">
3742
- - The first result from the query, or null if an error occurs or no results are found.
3743
- </div>
3744
-
3745
3759
 
3746
- </div>
3747
3760
 
3748
3761
 
3749
3762
 
3750
- </div>
3751
3763
 
3752
3764
 
3753
- <div class="section-method">
3754
3765
 
3755
3766
 
3756
3767
 
3757
- <h4 class="name" id="fetchSongArtistCount"><span class="type-signature">(async) </span>fetchSongArtistCount<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(int|null)>}</span></h4>
3768
+ <h4 class="name" id="fetchSongArtistCount"><span class="type-signature type-signature-async">(async) </span>fetchSongArtistCount<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(int|null)>}</span></h4>
3758
3769
 
3759
3770
 
3760
3771
 
3761
3772
 
3762
3773
 
3763
- <div class="description">
3764
- Fetch current number of artists for songs within a brand.
3765
- </div>
3766
-
3767
-
3768
-
3769
-
3770
3774
 
3771
3775
  <dl class="details">
3772
-
3776
+
3777
+ <dt class="tag-description">Description:</dt>
3778
+ <dd class="tag-description"><ul class="dummy"><li>Fetch current number of artists for songs within a brand.</li></ul></dd>
3773
3779
 
3774
3780
 
3775
3781
 
3782
+ <dt class="tag-source">Source:</dt>
3783
+ <dd class="tag-source"><ul class="dummy"><li>
3784
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
3785
+ </li></ul></dd>
3786
+
3776
3787
 
3777
3788
 
3778
3789
 
@@ -3795,10 +3806,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3795
3806
 
3796
3807
 
3797
3808
 
3798
- <dt class="tag-source">Source:</dt>
3799
- <dd class="tag-source"><ul class="dummy"><li>
3800
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line73">line 73</a>
3801
- </li></ul></dd>
3809
+
3802
3810
 
3803
3811
 
3804
3812
 
@@ -3816,7 +3824,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3816
3824
 
3817
3825
 
3818
3826
 
3819
- <h5>Parameters:</h5>
3827
+
3828
+
3829
+
3830
+
3831
+ <h5 class="h5-parameters">Parameters:</h5>
3820
3832
 
3821
3833
 
3822
3834
  <table class="params">
@@ -3847,7 +3859,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3847
3859
  <td class="type">
3848
3860
 
3849
3861
 
3850
- <span class="param-type"><code>string</code></span>
3862
+ <span class="param-type">string</span>
3863
+
3851
3864
 
3852
3865
 
3853
3866
 
@@ -3857,10 +3870,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3857
3870
 
3858
3871
 
3859
3872
 
3860
- <td class="description last">
3861
- The current brand.
3862
-
3863
- </td>
3873
+ <td class="description last">The current brand.</td>
3864
3874
  </tr>
3865
3875
 
3866
3876
 
@@ -3880,59 +3890,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3880
3890
 
3881
3891
 
3882
3892
 
3883
- <div class="section-returns">
3884
- <h5>Returns:</h5>
3893
+
3894
+
3895
+ <h5 class="h5-returns">Returns:</h5>
3885
3896
 
3886
3897
 
3898
+ <div class="param-desc">
3899
+ - The fetched count of artists.
3900
+ </div>
3901
+
3902
+
3887
3903
 
3888
3904
  <dl class="param-type">
3889
3905
  <dt>
3890
- Type:
3906
+ Type
3891
3907
  </dt>
3892
3908
  <dd>
3893
3909
 
3894
- <span class="param-type"><code>Promise.&lt;(int|null)></code></span>
3910
+ <span class="param-type">Promise.&lt;(int|null)></span>
3911
+
3895
3912
 
3896
3913
 
3897
3914
  </dd>
3898
3915
  </dl>
3899
3916
 
3900
-
3901
- <div class="param-desc">
3902
- - The fetched count of artists.
3903
- </div>
3904
-
3905
3917
 
3906
- </div>
3907
3918
 
3908
3919
 
3909
3920
 
3910
- </div>
3911
3921
 
3912
3922
 
3913
- <div class="section-method">
3914
-
3915
-
3916
-
3917
- <h4 class="name" id="fetchSongById"><span class="type-signature">(async) </span>fetchSongById<span class="signature">(documentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3918
-
3919
-
3920
-
3921
3923
 
3924
+
3922
3925
 
3923
- <div class="description">
3924
- Fetch a song by its document ID from Sanity.
3925
- </div>
3926
+ <h4 class="name" id="fetchSongById"><span class="type-signature type-signature-async">(async) </span>fetchSongById<span class="signature">(documentId)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
3926
3927
 
3928
+
3927
3929
 
3928
3930
 
3929
3931
 
3930
3932
 
3931
3933
  <dl class="details">
3932
-
3934
+
3935
+ <dt class="tag-description">Description:</dt>
3936
+ <dd class="tag-description"><ul class="dummy"><li>Fetch a song by its document ID from Sanity.</li></ul></dd>
3933
3937
 
3934
3938
 
3935
3939
 
3940
+ <dt class="tag-source">Source:</dt>
3941
+ <dd class="tag-source"><ul class="dummy"><li>
3942
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line41">line 41</a>
3943
+ </li></ul></dd>
3944
+
3936
3945
 
3937
3946
 
3938
3947
 
@@ -3955,10 +3964,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3955
3964
 
3956
3965
 
3957
3966
 
3958
- <dt class="tag-source">Source:</dt>
3959
- <dd class="tag-source"><ul class="dummy"><li>
3960
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line34">line 34</a>
3961
- </li></ul></dd>
3967
+
3962
3968
 
3963
3969
 
3964
3970
 
@@ -3976,7 +3982,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
3976
3982
 
3977
3983
 
3978
3984
 
3979
- <h5>Parameters:</h5>
3985
+
3986
+
3987
+ <h5 class="h5-examples">Example</h5>
3988
+
3989
+ <pre class="prettyprint"><code>fetchSongById('abc123')
3990
+ .then(song => console.log(song))
3991
+ .catch(error => console.error(error));</code></pre>
3992
+
3993
+
3994
+
3995
+
3996
+ <h5 class="h5-parameters">Parameters:</h5>
3980
3997
 
3981
3998
 
3982
3999
  <table class="params">
@@ -4007,7 +4024,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4007
4024
  <td class="type">
4008
4025
 
4009
4026
 
4010
- <span class="param-type"><code>string</code></span>
4027
+ <span class="param-type">string</span>
4028
+
4011
4029
 
4012
4030
 
4013
4031
 
@@ -4017,10 +4035,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4017
4035
 
4018
4036
 
4019
4037
 
4020
- <td class="description last">
4021
- The ID of the document to fetch.
4022
-
4023
- </td>
4038
+ <td class="description last">The ID of the document to fetch.</td>
4024
4039
  </tr>
4025
4040
 
4026
4041
 
@@ -4040,59 +4055,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4040
4055
 
4041
4056
 
4042
4057
 
4043
- <div class="section-returns">
4044
- <h5>Returns:</h5>
4058
+
4059
+
4060
+ <h5 class="h5-returns">Returns:</h5>
4045
4061
 
4046
4062
 
4063
+ <div class="param-desc">
4064
+ - A promise that resolves to an object containing the song data or null if not found.
4065
+ </div>
4066
+
4067
+
4047
4068
 
4048
4069
  <dl class="param-type">
4049
4070
  <dt>
4050
- Type:
4071
+ Type
4051
4072
  </dt>
4052
4073
  <dd>
4053
4074
 
4054
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
4075
+ <span class="param-type">Promise.&lt;(Object|null)></span>
4076
+
4055
4077
 
4056
4078
 
4057
4079
  </dd>
4058
4080
  </dl>
4059
4081
 
4060
-
4061
- <div class="param-desc">
4062
- - The fetched song data or null if not found.
4063
- </div>
4064
-
4065
4082
 
4066
- </div>
4067
4083
 
4068
4084
 
4069
4085
 
4070
- </div>
4071
4086
 
4072
4087
 
4073
- <div class="section-method">
4074
4088
 
4075
4089
 
4076
4090
 
4077
- <h4 class="name" id="fetchSongCount"><span class="type-signature">(async) </span>fetchSongCount<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(number|null)>}</span></h4>
4091
+ <h4 class="name" id="fetchSongCount"><span class="type-signature type-signature-async">(async) </span>fetchSongCount<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(number|null)>}</span></h4>
4078
4092
 
4079
4093
 
4080
4094
 
4081
4095
 
4082
4096
 
4083
- <div class="description">
4084
- Fetch the total count of songs for a specific brand.
4085
- </div>
4086
-
4087
-
4088
-
4089
-
4090
4097
 
4091
4098
  <dl class="details">
4092
-
4099
+
4100
+ <dt class="tag-description">Description:</dt>
4101
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the total count of songs for a specific brand.</li></ul></dd>
4093
4102
 
4094
4103
 
4095
4104
 
4105
+ <dt class="tag-source">Source:</dt>
4106
+ <dd class="tag-source"><ul class="dummy"><li>
4107
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line363">line 363</a>
4108
+ </li></ul></dd>
4109
+
4096
4110
 
4097
4111
 
4098
4112
 
@@ -4115,10 +4129,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4115
4129
 
4116
4130
 
4117
4131
 
4118
- <dt class="tag-source">Source:</dt>
4119
- <dd class="tag-source"><ul class="dummy"><li>
4120
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line326">line 326</a>
4121
- </li></ul></dd>
4132
+
4122
4133
 
4123
4134
 
4124
4135
 
@@ -4136,7 +4147,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4136
4147
 
4137
4148
 
4138
4149
 
4139
- <h5>Parameters:</h5>
4150
+
4151
+
4152
+
4153
+
4154
+ <h5 class="h5-parameters">Parameters:</h5>
4140
4155
 
4141
4156
 
4142
4157
  <table class="params">
@@ -4167,7 +4182,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4167
4182
  <td class="type">
4168
4183
 
4169
4184
 
4170
- <span class="param-type"><code>string</code></span>
4185
+ <span class="param-type">string</span>
4186
+
4171
4187
 
4172
4188
 
4173
4189
 
@@ -4177,10 +4193,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4177
4193
 
4178
4194
 
4179
4195
 
4180
- <td class="description last">
4181
- The brand for which to fetch the song count.
4182
-
4183
- </td>
4196
+ <td class="description last">The brand for which to fetch the song count.</td>
4184
4197
  </tr>
4185
4198
 
4186
4199
 
@@ -4200,59 +4213,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4200
4213
 
4201
4214
 
4202
4215
 
4203
- <div class="section-returns">
4204
- <h5>Returns:</h5>
4216
+
4217
+
4218
+ <h5 class="h5-returns">Returns:</h5>
4205
4219
 
4206
4220
 
4221
+ <div class="param-desc">
4222
+ - The total count of songs or null if an error occurs.
4223
+ </div>
4224
+
4225
+
4207
4226
 
4208
4227
  <dl class="param-type">
4209
4228
  <dt>
4210
- Type:
4229
+ Type
4211
4230
  </dt>
4212
4231
  <dd>
4213
4232
 
4214
- <span class="param-type"><code>Promise.&lt;(number|null)></code></span>
4233
+ <span class="param-type">Promise.&lt;(number|null)></span>
4234
+
4215
4235
 
4216
4236
 
4217
4237
  </dd>
4218
4238
  </dl>
4219
4239
 
4220
-
4221
- <div class="param-desc">
4222
- - The total count of songs or null if an error occurs.
4223
- </div>
4224
-
4225
4240
 
4226
- </div>
4227
4241
 
4228
4242
 
4229
4243
 
4230
- </div>
4231
4244
 
4232
4245
 
4233
- <div class="section-method">
4234
4246
 
4235
4247
 
4236
4248
 
4237
- <h4 class="name" id="fetchSongFilterOptions"><span class="type-signature">(async) </span>fetchSongFilterOptions<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4249
+ <h4 class="name" id="fetchSongFilterOptions"><span class="type-signature type-signature-async">(async) </span>fetchSongFilterOptions<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4238
4250
 
4239
4251
 
4240
4252
 
4241
4253
 
4242
4254
 
4243
- <div class="description">
4244
- Fetch filter options for a specific brand.
4245
- </div>
4246
-
4247
-
4248
-
4249
-
4250
4255
 
4251
4256
  <dl class="details">
4252
-
4257
+
4258
+ <dt class="tag-description">Description:</dt>
4259
+ <dd class="tag-description"><ul class="dummy"><li>Fetch filter options for a specific brand.</li></ul></dd>
4253
4260
 
4254
4261
 
4255
4262
 
4263
+ <dt class="tag-source">Source:</dt>
4264
+ <dd class="tag-source"><ul class="dummy"><li>
4265
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line334">line 334</a>
4266
+ </li></ul></dd>
4267
+
4256
4268
 
4257
4269
 
4258
4270
 
@@ -4275,10 +4287,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4275
4287
 
4276
4288
 
4277
4289
 
4278
- <dt class="tag-source">Source:</dt>
4279
- <dd class="tag-source"><ul class="dummy"><li>
4280
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line297">line 297</a>
4281
- </li></ul></dd>
4290
+
4282
4291
 
4283
4292
 
4284
4293
 
@@ -4296,7 +4305,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4296
4305
 
4297
4306
 
4298
4307
 
4299
- <h5>Parameters:</h5>
4308
+
4309
+
4310
+ <h5 class="h5-examples">Example</h5>
4311
+
4312
+ <pre class="prettyprint"><code>fetchSongFilterOptions('drumeo')
4313
+ .then(options => console.log(options))
4314
+ .catch(error => console.error(error));</code></pre>
4315
+
4316
+
4317
+
4318
+
4319
+ <h5 class="h5-parameters">Parameters:</h5>
4300
4320
 
4301
4321
 
4302
4322
  <table class="params">
@@ -4327,7 +4347,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4327
4347
  <td class="type">
4328
4348
 
4329
4349
 
4330
- <span class="param-type"><code>string</code></span>
4350
+ <span class="param-type">string</span>
4351
+
4331
4352
 
4332
4353
 
4333
4354
 
@@ -4337,10 +4358,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4337
4358
 
4338
4359
 
4339
4360
 
4340
- <td class="description last">
4341
- The brand for which to fetch filter options.
4342
-
4343
- </td>
4361
+ <td class="description last">The brand for which to fetch filter options.</td>
4344
4362
  </tr>
4345
4363
 
4346
4364
 
@@ -4360,59 +4378,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4360
4378
 
4361
4379
 
4362
4380
 
4363
- <div class="section-returns">
4364
- <h5>Returns:</h5>
4381
+
4382
+
4383
+ <h5 class="h5-returns">Returns:</h5>
4365
4384
 
4366
4385
 
4386
+ <div class="param-desc">
4387
+ - A promise that resolves to an object containing filter options or null if not found.
4388
+ </div>
4389
+
4390
+
4367
4391
 
4368
4392
  <dl class="param-type">
4369
4393
  <dt>
4370
- Type:
4394
+ Type
4371
4395
  </dt>
4372
4396
  <dd>
4373
4397
 
4374
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
4398
+ <span class="param-type">Promise.&lt;(Object|null)></span>
4399
+
4375
4400
 
4376
4401
 
4377
4402
  </dd>
4378
4403
  </dl>
4379
4404
 
4380
-
4381
- <div class="param-desc">
4382
- - The fetched filter options or null if not found.
4383
- </div>
4384
-
4385
4405
 
4386
- </div>
4387
4406
 
4388
4407
 
4389
4408
 
4390
- </div>
4391
4409
 
4392
4410
 
4393
- <div class="section-method">
4394
4411
 
4395
4412
 
4396
4413
 
4397
- <h4 class="name" id="fetchUpcomingEvents"><span class="type-signature">(async) </span>fetchUpcomingEvents<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4414
+ <h4 class="name" id="fetchUpcomingEvents"><span class="type-signature type-signature-async">(async) </span>fetchUpcomingEvents<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4398
4415
 
4399
4416
 
4400
4417
 
4401
4418
 
4402
4419
 
4403
- <div class="description">
4404
- Fetch upcoming events for a specific brand.
4405
- </div>
4406
-
4407
-
4408
-
4409
-
4410
4420
 
4411
4421
  <dl class="details">
4412
-
4422
+
4423
+ <dt class="tag-description">Description:</dt>
4424
+ <dd class="tag-description"><ul class="dummy"><li>Fetch upcoming events for a specific brand.</li></ul></dd>
4413
4425
 
4414
4426
 
4415
4427
 
4428
+ <dt class="tag-source">Source:</dt>
4429
+ <dd class="tag-source"><ul class="dummy"><li>
4430
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line427">line 427</a>
4431
+ </li></ul></dd>
4432
+
4416
4433
 
4417
4434
 
4418
4435
 
@@ -4435,10 +4452,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4435
4452
 
4436
4453
 
4437
4454
 
4438
- <dt class="tag-source">Source:</dt>
4439
- <dd class="tag-source"><ul class="dummy"><li>
4440
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line384">line 384</a>
4441
- </li></ul></dd>
4455
+
4442
4456
 
4443
4457
 
4444
4458
 
@@ -4456,7 +4470,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4456
4470
 
4457
4471
 
4458
4472
 
4459
- <h5>Parameters:</h5>
4473
+
4474
+
4475
+ <h5 class="h5-examples">Example</h5>
4476
+
4477
+ <pre class="prettyprint"><code>fetchUpcomingEvents('drumeo')
4478
+ .then(events => console.log(events))
4479
+ .catch(error => console.error(error));</code></pre>
4480
+
4481
+
4482
+
4483
+
4484
+ <h5 class="h5-parameters">Parameters:</h5>
4460
4485
 
4461
4486
 
4462
4487
  <table class="params">
@@ -4487,7 +4512,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4487
4512
  <td class="type">
4488
4513
 
4489
4514
 
4490
- <span class="param-type"><code>string</code></span>
4515
+ <span class="param-type">string</span>
4516
+
4491
4517
 
4492
4518
 
4493
4519
 
@@ -4497,10 +4523,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4497
4523
 
4498
4524
 
4499
4525
 
4500
- <td class="description last">
4501
- The brand for which to fetch upcoming events.
4502
-
4503
- </td>
4526
+ <td class="description last">The brand for which to fetch upcoming events.</td>
4504
4527
  </tr>
4505
4528
 
4506
4529
 
@@ -4520,59 +4543,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4520
4543
 
4521
4544
 
4522
4545
 
4523
- <div class="section-returns">
4524
- <h5>Returns:</h5>
4546
+
4547
+
4548
+ <h5 class="h5-returns">Returns:</h5>
4525
4549
 
4526
4550
 
4551
+ <div class="param-desc">
4552
+ - A promise that resolves to an array of upcoming event objects or null if not found.
4553
+ </div>
4554
+
4555
+
4527
4556
 
4528
4557
  <dl class="param-type">
4529
4558
  <dt>
4530
- Type:
4559
+ Type
4531
4560
  </dt>
4532
4561
  <dd>
4533
4562
 
4534
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
4563
+ <span class="param-type">Promise.&lt;(Object|null)></span>
4564
+
4535
4565
 
4536
4566
 
4537
4567
  </dd>
4538
4568
  </dl>
4539
4569
 
4540
-
4541
- <div class="param-desc">
4542
- - The fetched upcoming events data or null if not found.
4543
- </div>
4544
-
4545
4570
 
4546
- </div>
4547
4571
 
4548
4572
 
4549
4573
 
4550
- </div>
4551
4574
 
4552
4575
 
4553
- <div class="section-method">
4554
4576
 
4555
4577
 
4556
4578
 
4557
- <h4 class="name" id="fetchWorkouts"><span class="type-signature">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4579
+ <h4 class="name" id="fetchWorkouts"><span class="type-signature type-signature-async">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
4558
4580
 
4559
4581
 
4560
4582
 
4561
4583
 
4562
4584
 
4563
- <div class="description">
4564
- Fetch the latest workouts for the home page of a specific brand.
4565
- </div>
4566
-
4567
-
4568
-
4569
-
4570
4585
 
4571
4586
  <dl class="details">
4572
-
4587
+
4588
+ <dt class="tag-description">Description:</dt>
4589
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the latest workouts for the home page of a specific brand.</li></ul></dd>
4573
4590
 
4574
4591
 
4575
4592
 
4593
+ <dt class="tag-source">Source:</dt>
4594
+ <dd class="tag-source"><ul class="dummy"><li>
4595
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line373">line 373</a>
4596
+ </li></ul></dd>
4597
+
4576
4598
 
4577
4599
 
4578
4600
 
@@ -4595,10 +4617,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4595
4617
 
4596
4618
 
4597
4619
 
4598
- <dt class="tag-source">Source:</dt>
4599
- <dd class="tag-source"><ul class="dummy"><li>
4600
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line336">line 336</a>
4601
- </li></ul></dd>
4620
+
4602
4621
 
4603
4622
 
4604
4623
 
@@ -4616,7 +4635,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4616
4635
 
4617
4636
 
4618
4637
 
4619
- <h5>Parameters:</h5>
4638
+
4639
+
4640
+
4641
+
4642
+ <h5 class="h5-parameters">Parameters:</h5>
4620
4643
 
4621
4644
 
4622
4645
  <table class="params">
@@ -4647,7 +4670,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4647
4670
  <td class="type">
4648
4671
 
4649
4672
 
4650
- <span class="param-type"><code>string</code></span>
4673
+ <span class="param-type">string</span>
4674
+
4651
4675
 
4652
4676
 
4653
4677
 
@@ -4657,10 +4681,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4657
4681
 
4658
4682
 
4659
4683
 
4660
- <td class="description last">
4661
- The brand for which to fetch workouts.
4662
-
4663
- </td>
4684
+ <td class="description last">The brand for which to fetch workouts.</td>
4664
4685
  </tr>
4665
4686
 
4666
4687
 
@@ -4680,37 +4701,36 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4680
4701
 
4681
4702
 
4682
4703
 
4683
- <div class="section-returns">
4684
- <h5>Returns:</h5>
4704
+
4705
+
4706
+ <h5 class="h5-returns">Returns:</h5>
4685
4707
 
4686
4708
 
4709
+ <div class="param-desc">
4710
+ - The fetched workout data or null if not found.
4711
+ </div>
4712
+
4713
+
4687
4714
 
4688
4715
  <dl class="param-type">
4689
4716
  <dt>
4690
- Type:
4717
+ Type
4691
4718
  </dt>
4692
4719
  <dd>
4693
4720
 
4694
- <span class="param-type"><code>Promise.&lt;(Object|null)></code></span>
4721
+ <span class="param-type">Promise.&lt;(Object|null)></span>
4722
+
4695
4723
 
4696
4724
 
4697
4725
  </dd>
4698
4726
  </dl>
4699
4727
 
4700
-
4701
- <div class="param-desc">
4702
- - The fetched workout data or null if not found.
4703
- </div>
4704
-
4705
4728
 
4706
- </div>
4707
4729
 
4708
4730
 
4709
4731
 
4710
- </div>
4711
4732
 
4712
4733
 
4713
- <div class="section-method">
4714
4734
 
4715
4735
 
4716
4736
 
@@ -4720,20 +4740,20 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
4720
4740
 
4721
4741
 
4722
4742
 
4723
- <div class="description">
4724
- Initializes the Sanity service with the given configuration.
4725
- This function must be called before using any other functions in this library.
4726
- </div>
4727
-
4728
-
4729
-
4730
-
4731
4743
 
4732
4744
  <dl class="details">
4733
-
4745
+
4746
+ <dt class="tag-description">Description:</dt>
4747
+ <dd class="tag-description"><ul class="dummy"><li>Initializes the Sanity service with the given configuration.
4748
+ This function must be called before using any other functions in this library.</li></ul></dd>
4734
4749
 
4735
4750
 
4736
4751
 
4752
+ <dt class="tag-source">Source:</dt>
4753
+ <dd class="tag-source"><ul class="dummy"><li>
4754
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line26">line 26</a>
4755
+ </li></ul></dd>
4756
+
4737
4757
 
4738
4758
 
4739
4759
 
@@ -4756,10 +4776,7 @@ This function must be called before using any other functions in this library.
4756
4776
 
4757
4777
 
4758
4778
 
4759
- <dt class="tag-source">Source:</dt>
4760
- <dd class="tag-source"><ul class="dummy"><li>
4761
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line25">line 25</a>
4762
- </li></ul></dd>
4779
+
4763
4780
 
4764
4781
 
4765
4782
 
@@ -4777,7 +4794,24 @@ This function must be called before using any other functions in this library.
4777
4794
 
4778
4795
 
4779
4796
 
4780
- <h5>Parameters:</h5>
4797
+
4798
+
4799
+ <h5 class="h5-examples">Example</h5>
4800
+
4801
+ <pre class="prettyprint"><code>// Initialize the Sanity service in your app.js
4802
+ initializeSanityService({
4803
+ token: 'your-sanity-api-token',
4804
+ projectId: 'your-sanity-project-id',
4805
+ dataset: 'your-dataset-name',
4806
+ version: '2021-06-07',
4807
+ debug: true, // Optional: Enable debug mode
4808
+ useCachedAPI: true // Optional: Use cached API
4809
+ });</code></pre>
4810
+
4811
+
4812
+
4813
+
4814
+ <h5 class="h5-parameters">Parameters:</h5>
4781
4815
 
4782
4816
 
4783
4817
  <table class="params">
@@ -4808,7 +4842,8 @@ This function must be called before using any other functions in this library.
4808
4842
  <td class="type">
4809
4843
 
4810
4844
 
4811
- <span class="param-type"><code>Object</code></span>
4845
+ <span class="param-type">Object</span>
4846
+
4812
4847
 
4813
4848
 
4814
4849
 
@@ -4818,10 +4853,9 @@ This function must be called before using any other functions in this library.
4818
4853
 
4819
4854
 
4820
4855
 
4821
- <td class="description last">
4822
- Configuration object containing Sanity API settings.
4856
+ <td class="description last">Configuration object containing Sanity API settings.
4857
+ <h6>Properties</h6>
4823
4858
 
4824
-
4825
4859
 
4826
4860
  <table class="params">
4827
4861
  <thead>
@@ -4855,7 +4889,8 @@ This function must be called before using any other functions in this library.
4855
4889
  <td class="type">
4856
4890
 
4857
4891
 
4858
- <span class="param-type"><code>string</code></span>
4892
+ <span class="param-type">string</span>
4893
+
4859
4894
 
4860
4895
 
4861
4896
 
@@ -4877,10 +4912,7 @@ This function must be called before using any other functions in this library.
4877
4912
  </td>
4878
4913
 
4879
4914
 
4880
- <td class="description last">
4881
- The API token for authenticating with Sanity.
4882
-
4883
- </td>
4915
+ <td class="description last">The API token for authenticating with Sanity.</td>
4884
4916
  </tr>
4885
4917
 
4886
4918
 
@@ -4893,7 +4925,8 @@ This function must be called before using any other functions in this library.
4893
4925
  <td class="type">
4894
4926
 
4895
4927
 
4896
- <span class="param-type"><code>string</code></span>
4928
+ <span class="param-type">string</span>
4929
+
4897
4930
 
4898
4931
 
4899
4932
 
@@ -4915,10 +4948,7 @@ This function must be called before using any other functions in this library.
4915
4948
  </td>
4916
4949
 
4917
4950
 
4918
- <td class="description last">
4919
- The project ID in Sanity.
4920
-
4921
- </td>
4951
+ <td class="description last">The project ID in Sanity.</td>
4922
4952
  </tr>
4923
4953
 
4924
4954
 
@@ -4931,7 +4961,8 @@ This function must be called before using any other functions in this library.
4931
4961
  <td class="type">
4932
4962
 
4933
4963
 
4934
- <span class="param-type"><code>string</code></span>
4964
+ <span class="param-type">string</span>
4965
+
4935
4966
 
4936
4967
 
4937
4968
 
@@ -4953,10 +4984,7 @@ This function must be called before using any other functions in this library.
4953
4984
  </td>
4954
4985
 
4955
4986
 
4956
- <td class="description last">
4957
- The dataset name in Sanity.
4958
-
4959
- </td>
4987
+ <td class="description last">The dataset name in Sanity.</td>
4960
4988
  </tr>
4961
4989
 
4962
4990
 
@@ -4969,7 +4997,8 @@ This function must be called before using any other functions in this library.
4969
4997
  <td class="type">
4970
4998
 
4971
4999
 
4972
- <span class="param-type"><code>string</code></span>
5000
+ <span class="param-type">string</span>
5001
+
4973
5002
 
4974
5003
 
4975
5004
 
@@ -4991,10 +5020,7 @@ This function must be called before using any other functions in this library.
4991
5020
  </td>
4992
5021
 
4993
5022
 
4994
- <td class="description last">
4995
- The API version to use.
4996
-
4997
- </td>
5023
+ <td class="description last">The API version to use.</td>
4998
5024
  </tr>
4999
5025
 
5000
5026
 
@@ -5007,7 +5033,8 @@ This function must be called before using any other functions in this library.
5007
5033
  <td class="type">
5008
5034
 
5009
5035
 
5010
- <span class="param-type"><code>boolean</code></span>
5036
+ <span class="param-type">boolean</span>
5037
+
5011
5038
 
5012
5039
 
5013
5040
 
@@ -5028,15 +5055,12 @@ This function must be called before using any other functions in this library.
5028
5055
 
5029
5056
  <td class="default">
5030
5057
 
5031
- false
5058
+ <code>false</code>
5032
5059
 
5033
5060
  </td>
5034
5061
 
5035
5062
 
5036
- <td class="description last">
5037
- Optional flag to enable debug mode, which logs the query and results.
5038
-
5039
- </td>
5063
+ <td class="description last">Optional flag to enable debug mode, which logs the query and results.</td>
5040
5064
  </tr>
5041
5065
 
5042
5066
 
@@ -5049,7 +5073,8 @@ This function must be called before using any other functions in this library.
5049
5073
  <td class="type">
5050
5074
 
5051
5075
 
5052
- <span class="param-type"><code>boolean</code></span>
5076
+ <span class="param-type">boolean</span>
5077
+
5053
5078
 
5054
5079
 
5055
5080
 
@@ -5070,22 +5095,18 @@ This function must be called before using any other functions in this library.
5070
5095
 
5071
5096
  <td class="default">
5072
5097
 
5073
- true
5098
+ <code>true</code>
5074
5099
 
5075
5100
  </td>
5076
5101
 
5077
5102
 
5078
- <td class="description last">
5079
- Optional flag to disable cached API. *
5080
-
5081
- </td>
5103
+ <td class="description last">Optional flag to disable cached API.</td>
5082
5104
  </tr>
5083
5105
 
5084
5106
 
5085
5107
  </tbody>
5086
5108
  </table>
5087
5109
 
5088
-
5089
5110
  </td>
5090
5111
  </tr>
5091
5112
 
@@ -5108,22 +5129,9 @@ This function must be called before using any other functions in this library.
5108
5129
 
5109
5130
 
5110
5131
 
5111
- <div class="section-examples">
5112
- <h5>Example</h5>
5113
5132
 
5114
- <pre class="prettyprint"><code>// Initialize the Sanity service in your app.js
5115
- initializeSanityService({
5116
- token: 'your-sanity-api-token',
5117
- projectId: 'your-sanity-project-id',
5118
- dataset: 'your-dataset-name',
5119
- version: '2021-06-07',
5120
- debug: true // Optional: Enable debug mode
5121
- useCachedAPI: true // Optional: Use cached API
5122
- });</code></pre>
5123
5133
 
5124
- </div>
5125
5134
 
5126
- </div>
5127
5135
 
5128
5136
 
5129
5137
 
@@ -5137,15 +5145,21 @@ initializeSanityService({
5137
5145
 
5138
5146
 
5139
5147
 
5148
+
5149
+
5140
5150
  </div>
5141
5151
 
5142
5152
  <br class="clear">
5143
5153
 
5144
5154
  <footer>
5145
- Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 12 2024 13:37:15 GMT+0000 (Coordinated Universal Time) using the Minami theme.
5155
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 12 2024 15:31:44 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5146
5156
  </footer>
5147
5157
 
5148
5158
  <script>prettyPrint();</script>
5159
+ <script src="scripts/polyfill.js"></script>
5149
5160
  <script src="scripts/linenumber.js"></script>
5161
+
5162
+
5163
+
5150
5164
  </body>
5151
5165
  </html>