musora-content-services 1.0.9 → 1.0.10
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.
- package/CHANGELOG.md +2 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/global.html +846 -931
- package/docs/index.html +27 -9
- package/docs/index.js.html +20 -8
- package/docs/scripts/collapse.js +39 -0
- package/docs/scripts/commonNav.js +28 -0
- package/docs/scripts/nav.js +12 -0
- package/docs/scripts/polyfill.js +4 -0
- package/docs/scripts/search.js +99 -265
- package/docs/styles/jsdoc.css +776 -0
- package/docs/styles/prettify.css +80 -0
- package/jsdoc.json +1 -1
- package/package.json +5 -4
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="
|
|
14
|
-
<link type="text/css" rel="stylesheet" href="styles/
|
|
15
|
-
<
|
|
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
|
-
|
|
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"> → {Promise.<(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"> → {Promise.<(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#line463">line 463</a>
|
|
150
|
+
</li></ul></dd>
|
|
151
|
+
|
|
139
152
|
|
|
140
153
|
|
|
141
154
|
|
|
@@ -158,10 +171,7 @@
|
|
|
158
171
|
|
|
159
172
|
|
|
160
173
|
|
|
161
|
-
|
|
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,11 @@
|
|
|
179
189
|
|
|
180
190
|
|
|
181
191
|
|
|
182
|
-
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
183
197
|
|
|
184
198
|
|
|
185
199
|
<table class="params">
|
|
@@ -210,7 +224,8 @@
|
|
|
210
224
|
<td class="type">
|
|
211
225
|
|
|
212
226
|
|
|
213
|
-
<span class="param-type"
|
|
227
|
+
<span class="param-type">string</span>
|
|
228
|
+
|
|
214
229
|
|
|
215
230
|
|
|
216
231
|
|
|
@@ -220,10 +235,7 @@
|
|
|
220
235
|
|
|
221
236
|
|
|
222
237
|
|
|
223
|
-
<td class="description last">
|
|
224
|
-
The brand for which to fetch content.
|
|
225
|
-
|
|
226
|
-
</td>
|
|
238
|
+
<td class="description last">The brand for which to fetch content.</td>
|
|
227
239
|
</tr>
|
|
228
240
|
|
|
229
241
|
|
|
@@ -236,7 +248,8 @@
|
|
|
236
248
|
<td class="type">
|
|
237
249
|
|
|
238
250
|
|
|
239
|
-
<span class="param-type"
|
|
251
|
+
<span class="param-type">string</span>
|
|
252
|
+
|
|
240
253
|
|
|
241
254
|
|
|
242
255
|
|
|
@@ -246,10 +259,7 @@
|
|
|
246
259
|
|
|
247
260
|
|
|
248
261
|
|
|
249
|
-
<td class="description last">
|
|
250
|
-
The content type to fetch (e.g., 'song', 'artist').
|
|
251
|
-
|
|
252
|
-
</td>
|
|
262
|
+
<td class="description last">The content type to fetch (e.g., 'song', 'artist').</td>
|
|
253
263
|
</tr>
|
|
254
264
|
|
|
255
265
|
|
|
@@ -262,7 +272,8 @@
|
|
|
262
272
|
<td class="type">
|
|
263
273
|
|
|
264
274
|
|
|
265
|
-
<span class="param-type"
|
|
275
|
+
<span class="param-type">Object</span>
|
|
276
|
+
|
|
266
277
|
|
|
267
278
|
|
|
268
279
|
|
|
@@ -272,10 +283,9 @@
|
|
|
272
283
|
|
|
273
284
|
|
|
274
285
|
|
|
275
|
-
<td class="description last">
|
|
276
|
-
|
|
286
|
+
<td class="description last">Parameters for pagination, filtering, sorting, and grouping.
|
|
287
|
+
<h6>Properties</h6>
|
|
277
288
|
|
|
278
|
-
|
|
279
289
|
|
|
280
290
|
<table class="params">
|
|
281
291
|
<thead>
|
|
@@ -309,7 +319,8 @@
|
|
|
309
319
|
<td class="type">
|
|
310
320
|
|
|
311
321
|
|
|
312
|
-
<span class="param-type"
|
|
322
|
+
<span class="param-type">number</span>
|
|
323
|
+
|
|
313
324
|
|
|
314
325
|
|
|
315
326
|
|
|
@@ -330,15 +341,12 @@
|
|
|
330
341
|
|
|
331
342
|
<td class="default">
|
|
332
343
|
|
|
333
|
-
1
|
|
344
|
+
<code>1</code>
|
|
334
345
|
|
|
335
346
|
</td>
|
|
336
347
|
|
|
337
348
|
|
|
338
|
-
<td class="description last">
|
|
339
|
-
The page number for pagination.
|
|
340
|
-
|
|
341
|
-
</td>
|
|
349
|
+
<td class="description last">The page number for pagination.</td>
|
|
342
350
|
</tr>
|
|
343
351
|
|
|
344
352
|
|
|
@@ -351,7 +359,8 @@
|
|
|
351
359
|
<td class="type">
|
|
352
360
|
|
|
353
361
|
|
|
354
|
-
<span class="param-type"
|
|
362
|
+
<span class="param-type">number</span>
|
|
363
|
+
|
|
355
364
|
|
|
356
365
|
|
|
357
366
|
|
|
@@ -372,15 +381,12 @@
|
|
|
372
381
|
|
|
373
382
|
<td class="default">
|
|
374
383
|
|
|
375
|
-
10
|
|
384
|
+
<code>10</code>
|
|
376
385
|
|
|
377
386
|
</td>
|
|
378
387
|
|
|
379
388
|
|
|
380
|
-
<td class="description last">
|
|
381
|
-
The number of items per page.
|
|
382
|
-
|
|
383
|
-
</td>
|
|
389
|
+
<td class="description last">The number of items per page.</td>
|
|
384
390
|
</tr>
|
|
385
391
|
|
|
386
392
|
|
|
@@ -393,7 +399,8 @@
|
|
|
393
399
|
<td class="type">
|
|
394
400
|
|
|
395
401
|
|
|
396
|
-
<span class="param-type"
|
|
402
|
+
<span class="param-type">string</span>
|
|
403
|
+
|
|
397
404
|
|
|
398
405
|
|
|
399
406
|
|
|
@@ -414,15 +421,12 @@
|
|
|
414
421
|
|
|
415
422
|
<td class="default">
|
|
416
423
|
|
|
417
|
-
""
|
|
424
|
+
<code>""</code>
|
|
418
425
|
|
|
419
426
|
</td>
|
|
420
427
|
|
|
421
428
|
|
|
422
|
-
<td class="description last">
|
|
423
|
-
The search term to filter content by title or artist.
|
|
424
|
-
|
|
425
|
-
</td>
|
|
429
|
+
<td class="description last">The search term to filter content by title or artist.</td>
|
|
426
430
|
</tr>
|
|
427
431
|
|
|
428
432
|
|
|
@@ -435,7 +439,8 @@
|
|
|
435
439
|
<td class="type">
|
|
436
440
|
|
|
437
441
|
|
|
438
|
-
<span class="param-type"
|
|
442
|
+
<span class="param-type">string</span>
|
|
443
|
+
|
|
439
444
|
|
|
440
445
|
|
|
441
446
|
|
|
@@ -456,15 +461,12 @@
|
|
|
456
461
|
|
|
457
462
|
<td class="default">
|
|
458
463
|
|
|
459
|
-
"-published_on"
|
|
464
|
+
<code>"-published_on"</code>
|
|
460
465
|
|
|
461
466
|
</td>
|
|
462
467
|
|
|
463
468
|
|
|
464
|
-
<td class="description last">
|
|
465
|
-
The field to sort the content by.
|
|
466
|
-
|
|
467
|
-
</td>
|
|
469
|
+
<td class="description last">The field to sort the content by.</td>
|
|
468
470
|
</tr>
|
|
469
471
|
|
|
470
472
|
|
|
@@ -477,7 +479,8 @@
|
|
|
477
479
|
<td class="type">
|
|
478
480
|
|
|
479
481
|
|
|
480
|
-
<span class="param-type"
|
|
482
|
+
<span class="param-type">Array.<string></span>
|
|
483
|
+
|
|
481
484
|
|
|
482
485
|
|
|
483
486
|
|
|
@@ -498,15 +501,12 @@
|
|
|
498
501
|
|
|
499
502
|
<td class="default">
|
|
500
503
|
|
|
501
|
-
[]
|
|
504
|
+
<code>[]</code>
|
|
502
505
|
|
|
503
506
|
</td>
|
|
504
507
|
|
|
505
508
|
|
|
506
|
-
<td class="description last">
|
|
507
|
-
The fields to include in the query.
|
|
508
|
-
|
|
509
|
-
</td>
|
|
509
|
+
<td class="description last">The fields to include in the query.</td>
|
|
510
510
|
</tr>
|
|
511
511
|
|
|
512
512
|
|
|
@@ -519,7 +519,8 @@
|
|
|
519
519
|
<td class="type">
|
|
520
520
|
|
|
521
521
|
|
|
522
|
-
<span class="param-type"
|
|
522
|
+
<span class="param-type">string</span>
|
|
523
|
+
|
|
523
524
|
|
|
524
525
|
|
|
525
526
|
|
|
@@ -540,22 +541,18 @@
|
|
|
540
541
|
|
|
541
542
|
<td class="default">
|
|
542
543
|
|
|
543
|
-
""
|
|
544
|
+
<code>""</code>
|
|
544
545
|
|
|
545
546
|
</td>
|
|
546
547
|
|
|
547
548
|
|
|
548
|
-
<td class="description last">
|
|
549
|
-
The field to group the results by (e.g., 'artist', 'genre').
|
|
550
|
-
|
|
551
|
-
</td>
|
|
549
|
+
<td class="description last">The field to group the results by (e.g., 'artist', 'genre').</td>
|
|
552
550
|
</tr>
|
|
553
551
|
|
|
554
552
|
|
|
555
553
|
</tbody>
|
|
556
554
|
</table>
|
|
557
555
|
|
|
558
|
-
|
|
559
556
|
</td>
|
|
560
557
|
</tr>
|
|
561
558
|
|
|
@@ -576,62 +573,61 @@
|
|
|
576
573
|
|
|
577
574
|
|
|
578
575
|
|
|
579
|
-
|
|
580
|
-
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
581
579
|
|
|
582
580
|
|
|
581
|
+
<div class="param-desc">
|
|
582
|
+
- The fetched content data or null if not found.
|
|
583
|
+
</div>
|
|
584
|
+
|
|
585
|
+
|
|
583
586
|
|
|
584
587
|
<dl class="param-type">
|
|
585
588
|
<dt>
|
|
586
|
-
Type
|
|
589
|
+
Type
|
|
587
590
|
</dt>
|
|
588
591
|
<dd>
|
|
589
592
|
|
|
590
|
-
<span class="param-type"
|
|
593
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
594
|
+
|
|
591
595
|
|
|
592
596
|
|
|
593
597
|
</dd>
|
|
594
598
|
</dl>
|
|
595
599
|
|
|
596
|
-
|
|
597
|
-
<div class="param-desc">
|
|
598
|
-
- The fetched content data or null if not found.
|
|
599
|
-
</div>
|
|
600
|
-
|
|
601
600
|
|
|
602
|
-
</div>
|
|
603
601
|
|
|
604
602
|
|
|
605
603
|
|
|
606
|
-
</div>
|
|
607
604
|
|
|
608
605
|
|
|
609
|
-
<div class="section-method">
|
|
610
606
|
|
|
611
607
|
|
|
612
608
|
|
|
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"> → {Promise.<(Object|null)>}</span></h4>
|
|
609
|
+
<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"> → {Promise.<(Object|null)>}</span></h4>
|
|
614
610
|
|
|
615
611
|
|
|
616
612
|
|
|
617
613
|
|
|
618
614
|
|
|
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
615
|
|
|
630
616
|
<dl class="details">
|
|
617
|
+
|
|
618
|
+
<dt class="tag-description">Description:</dt>
|
|
619
|
+
<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
620
|
|
|
621
|
+
This function constructs a query to retrieve the total number of results and filter options such as difficulty, instrument type, and genre.
|
|
622
|
+
The filter options are dynamically generated based on the provided filters, style, artist, and content type.</li></ul></dd>
|
|
632
623
|
|
|
633
624
|
|
|
634
625
|
|
|
626
|
+
<dt class="tag-source">Source:</dt>
|
|
627
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
628
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line607">line 607</a>
|
|
629
|
+
</li></ul></dd>
|
|
630
|
+
|
|
635
631
|
|
|
636
632
|
|
|
637
633
|
|
|
@@ -654,10 +650,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
654
650
|
|
|
655
651
|
|
|
656
652
|
|
|
657
|
-
|
|
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>
|
|
653
|
+
|
|
661
654
|
|
|
662
655
|
|
|
663
656
|
|
|
@@ -675,7 +668,19 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
675
668
|
|
|
676
669
|
|
|
677
670
|
|
|
678
|
-
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
<h5 class="h5-examples">Example</h5>
|
|
674
|
+
|
|
675
|
+
<pre class="prettyprint"><code>// Example usage:
|
|
676
|
+
fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
677
|
+
.then(options => console.log(options))
|
|
678
|
+
.catch(error => console.error(error));</code></pre>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
679
684
|
|
|
680
685
|
|
|
681
686
|
<table class="params">
|
|
@@ -708,7 +713,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
708
713
|
<td class="type">
|
|
709
714
|
|
|
710
715
|
|
|
711
|
-
<span class="param-type"
|
|
716
|
+
<span class="param-type">string</span>
|
|
717
|
+
|
|
712
718
|
|
|
713
719
|
|
|
714
720
|
|
|
@@ -726,10 +732,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
726
732
|
|
|
727
733
|
|
|
728
734
|
|
|
729
|
-
<td class="description last">
|
|
730
|
-
The brand for which to fetch the filter options.
|
|
731
|
-
|
|
732
|
-
</td>
|
|
735
|
+
<td class="description last">The brand for which to fetch the filter options.</td>
|
|
733
736
|
</tr>
|
|
734
737
|
|
|
735
738
|
|
|
@@ -742,7 +745,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
742
745
|
<td class="type">
|
|
743
746
|
|
|
744
747
|
|
|
745
|
-
<span class="param-type"
|
|
748
|
+
<span class="param-type">string</span>
|
|
749
|
+
|
|
746
750
|
|
|
747
751
|
|
|
748
752
|
|
|
@@ -760,10 +764,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
760
764
|
|
|
761
765
|
|
|
762
766
|
|
|
763
|
-
<td class="description last">
|
|
764
|
-
Additional filters to apply to the query, typically in the format of Sanity GROQ queries.
|
|
765
|
-
|
|
766
|
-
</td>
|
|
767
|
+
<td class="description last">Additional filters to apply to the query, typically in the format of Sanity GROQ queries.</td>
|
|
767
768
|
</tr>
|
|
768
769
|
|
|
769
770
|
|
|
@@ -776,7 +777,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
776
777
|
<td class="type">
|
|
777
778
|
|
|
778
779
|
|
|
779
|
-
<span class="param-type"
|
|
780
|
+
<span class="param-type">string</span>
|
|
781
|
+
|
|
780
782
|
|
|
781
783
|
|
|
782
784
|
|
|
@@ -796,10 +798,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
796
798
|
|
|
797
799
|
|
|
798
800
|
|
|
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>
|
|
801
|
+
<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
802
|
</tr>
|
|
804
803
|
|
|
805
804
|
|
|
@@ -812,7 +811,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
812
811
|
<td class="type">
|
|
813
812
|
|
|
814
813
|
|
|
815
|
-
<span class="param-type"
|
|
814
|
+
<span class="param-type">string</span>
|
|
815
|
+
|
|
816
816
|
|
|
817
817
|
|
|
818
818
|
|
|
@@ -832,10 +832,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
832
832
|
|
|
833
833
|
|
|
834
834
|
|
|
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>
|
|
835
|
+
<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
836
|
</tr>
|
|
840
837
|
|
|
841
838
|
|
|
@@ -848,7 +845,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
848
845
|
<td class="type">
|
|
849
846
|
|
|
850
847
|
|
|
851
|
-
<span class="param-type"
|
|
848
|
+
<span class="param-type">string</span>
|
|
849
|
+
|
|
852
850
|
|
|
853
851
|
|
|
854
852
|
|
|
@@ -866,10 +864,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
866
864
|
|
|
867
865
|
|
|
868
866
|
|
|
869
|
-
<td class="description last">
|
|
870
|
-
The content type to fetch (e.g., 'song', 'lesson').
|
|
871
|
-
|
|
872
|
-
</td>
|
|
867
|
+
<td class="description last">The content type to fetch (e.g., 'song', 'lesson').</td>
|
|
873
868
|
</tr>
|
|
874
869
|
|
|
875
870
|
|
|
@@ -882,7 +877,8 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
882
877
|
<td class="type">
|
|
883
878
|
|
|
884
879
|
|
|
885
|
-
<span class="param-type"
|
|
880
|
+
<span class="param-type">string</span>
|
|
881
|
+
|
|
886
882
|
|
|
887
883
|
|
|
888
884
|
|
|
@@ -902,10 +898,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
902
898
|
|
|
903
899
|
|
|
904
900
|
|
|
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>
|
|
901
|
+
<td class="description last">Optional search term to match against various fields such as title, album, artist name, and genre.</td>
|
|
909
902
|
</tr>
|
|
910
903
|
|
|
911
904
|
|
|
@@ -925,69 +918,58 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
925
918
|
|
|
926
919
|
|
|
927
920
|
|
|
928
|
-
|
|
929
|
-
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
930
924
|
|
|
931
925
|
|
|
926
|
+
<div class="param-desc">
|
|
927
|
+
- A promise that resolves to an object containing the total results and filter options, or null if the query fails.
|
|
928
|
+
</div>
|
|
929
|
+
|
|
930
|
+
|
|
932
931
|
|
|
933
932
|
<dl class="param-type">
|
|
934
933
|
<dt>
|
|
935
|
-
Type
|
|
934
|
+
Type
|
|
936
935
|
</dt>
|
|
937
936
|
<dd>
|
|
938
937
|
|
|
939
|
-
<span class="param-type"
|
|
938
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
939
|
+
|
|
940
940
|
|
|
941
941
|
|
|
942
942
|
</dd>
|
|
943
943
|
</dl>
|
|
944
944
|
|
|
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
945
|
|
|
951
|
-
</div>
|
|
952
|
-
|
|
953
|
-
|
|
954
946
|
|
|
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
947
|
|
|
963
|
-
</div>
|
|
964
948
|
|
|
965
|
-
</div>
|
|
966
949
|
|
|
967
950
|
|
|
968
|
-
<div class="section-method">
|
|
969
951
|
|
|
970
952
|
|
|
971
953
|
|
|
972
|
-
<h4 class="name" id="fetchAllSongs"><span class="type-signature">(async) </span>fetchAllSongs<span class="signature">(brand, params)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
954
|
+
<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"> → {Promise.<(Object|null)>}</span></h4>
|
|
973
955
|
|
|
974
956
|
|
|
975
957
|
|
|
976
958
|
|
|
977
959
|
|
|
978
|
-
<div class="description">
|
|
979
|
-
Fetch all songs for a specific brand with pagination and search options.
|
|
980
|
-
</div>
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
960
|
|
|
986
961
|
<dl class="details">
|
|
987
|
-
|
|
962
|
+
|
|
963
|
+
<dt class="tag-description">Description:</dt>
|
|
964
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all songs for a specific brand with pagination and search options.</li></ul></dd>
|
|
988
965
|
|
|
989
966
|
|
|
990
967
|
|
|
968
|
+
<dt class="tag-source">Source:</dt>
|
|
969
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
970
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line164">line 164</a>
|
|
971
|
+
</li></ul></dd>
|
|
972
|
+
|
|
991
973
|
|
|
992
974
|
|
|
993
975
|
|
|
@@ -1010,10 +992,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1010
992
|
|
|
1011
993
|
|
|
1012
994
|
|
|
1013
|
-
|
|
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>
|
|
995
|
+
|
|
1017
996
|
|
|
1018
997
|
|
|
1019
998
|
|
|
@@ -1031,7 +1010,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1031
1010
|
|
|
1032
1011
|
|
|
1033
1012
|
|
|
1034
|
-
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1035
1018
|
|
|
1036
1019
|
|
|
1037
1020
|
<table class="params">
|
|
@@ -1062,7 +1045,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1062
1045
|
<td class="type">
|
|
1063
1046
|
|
|
1064
1047
|
|
|
1065
|
-
<span class="param-type"
|
|
1048
|
+
<span class="param-type">string</span>
|
|
1049
|
+
|
|
1066
1050
|
|
|
1067
1051
|
|
|
1068
1052
|
|
|
@@ -1072,10 +1056,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1072
1056
|
|
|
1073
1057
|
|
|
1074
1058
|
|
|
1075
|
-
<td class="description last">
|
|
1076
|
-
The brand for which to fetch songs.
|
|
1077
|
-
|
|
1078
|
-
</td>
|
|
1059
|
+
<td class="description last">The brand for which to fetch songs.</td>
|
|
1079
1060
|
</tr>
|
|
1080
1061
|
|
|
1081
1062
|
|
|
@@ -1088,7 +1069,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1088
1069
|
<td class="type">
|
|
1089
1070
|
|
|
1090
1071
|
|
|
1091
|
-
<span class="param-type"
|
|
1072
|
+
<span class="param-type">Object</span>
|
|
1073
|
+
|
|
1092
1074
|
|
|
1093
1075
|
|
|
1094
1076
|
|
|
@@ -1098,10 +1080,9 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1098
1080
|
|
|
1099
1081
|
|
|
1100
1082
|
|
|
1101
|
-
<td class="description last">
|
|
1102
|
-
|
|
1083
|
+
<td class="description last">Parameters for pagination, filtering, and sorting.
|
|
1084
|
+
<h6>Properties</h6>
|
|
1103
1085
|
|
|
1104
|
-
|
|
1105
1086
|
|
|
1106
1087
|
<table class="params">
|
|
1107
1088
|
<thead>
|
|
@@ -1135,7 +1116,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1135
1116
|
<td class="type">
|
|
1136
1117
|
|
|
1137
1118
|
|
|
1138
|
-
<span class="param-type"
|
|
1119
|
+
<span class="param-type">number</span>
|
|
1120
|
+
|
|
1139
1121
|
|
|
1140
1122
|
|
|
1141
1123
|
|
|
@@ -1156,15 +1138,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1156
1138
|
|
|
1157
1139
|
<td class="default">
|
|
1158
1140
|
|
|
1159
|
-
1
|
|
1141
|
+
<code>1</code>
|
|
1160
1142
|
|
|
1161
1143
|
</td>
|
|
1162
1144
|
|
|
1163
1145
|
|
|
1164
|
-
<td class="description last">
|
|
1165
|
-
The page number for pagination.
|
|
1166
|
-
|
|
1167
|
-
</td>
|
|
1146
|
+
<td class="description last">The page number for pagination.</td>
|
|
1168
1147
|
</tr>
|
|
1169
1148
|
|
|
1170
1149
|
|
|
@@ -1177,7 +1156,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1177
1156
|
<td class="type">
|
|
1178
1157
|
|
|
1179
1158
|
|
|
1180
|
-
<span class="param-type"
|
|
1159
|
+
<span class="param-type">number</span>
|
|
1160
|
+
|
|
1181
1161
|
|
|
1182
1162
|
|
|
1183
1163
|
|
|
@@ -1198,15 +1178,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1198
1178
|
|
|
1199
1179
|
<td class="default">
|
|
1200
1180
|
|
|
1201
|
-
10
|
|
1181
|
+
<code>10</code>
|
|
1202
1182
|
|
|
1203
1183
|
</td>
|
|
1204
1184
|
|
|
1205
1185
|
|
|
1206
|
-
<td class="description last">
|
|
1207
|
-
The number of songs per page.
|
|
1208
|
-
|
|
1209
|
-
</td>
|
|
1186
|
+
<td class="description last">The number of songs per page.</td>
|
|
1210
1187
|
</tr>
|
|
1211
1188
|
|
|
1212
1189
|
|
|
@@ -1219,7 +1196,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1219
1196
|
<td class="type">
|
|
1220
1197
|
|
|
1221
1198
|
|
|
1222
|
-
<span class="param-type"
|
|
1199
|
+
<span class="param-type">string</span>
|
|
1200
|
+
|
|
1223
1201
|
|
|
1224
1202
|
|
|
1225
1203
|
|
|
@@ -1240,15 +1218,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1240
1218
|
|
|
1241
1219
|
<td class="default">
|
|
1242
1220
|
|
|
1243
|
-
""
|
|
1221
|
+
<code>""</code>
|
|
1244
1222
|
|
|
1245
1223
|
</td>
|
|
1246
1224
|
|
|
1247
1225
|
|
|
1248
|
-
<td class="description last">
|
|
1249
|
-
The search term to filter songs by title or artist.
|
|
1250
|
-
|
|
1251
|
-
</td>
|
|
1226
|
+
<td class="description last">The search term to filter songs by title or artist.</td>
|
|
1252
1227
|
</tr>
|
|
1253
1228
|
|
|
1254
1229
|
|
|
@@ -1261,7 +1236,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1261
1236
|
<td class="type">
|
|
1262
1237
|
|
|
1263
1238
|
|
|
1264
|
-
<span class="param-type"
|
|
1239
|
+
<span class="param-type">string</span>
|
|
1240
|
+
|
|
1265
1241
|
|
|
1266
1242
|
|
|
1267
1243
|
|
|
@@ -1282,15 +1258,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1282
1258
|
|
|
1283
1259
|
<td class="default">
|
|
1284
1260
|
|
|
1285
|
-
"-published_on"
|
|
1261
|
+
<code>"-published_on"</code>
|
|
1286
1262
|
|
|
1287
1263
|
</td>
|
|
1288
1264
|
|
|
1289
1265
|
|
|
1290
|
-
<td class="description last">
|
|
1291
|
-
The field to sort the songs by.
|
|
1292
|
-
|
|
1293
|
-
</td>
|
|
1266
|
+
<td class="description last">The field to sort the songs by.</td>
|
|
1294
1267
|
</tr>
|
|
1295
1268
|
|
|
1296
1269
|
|
|
@@ -1303,7 +1276,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1303
1276
|
<td class="type">
|
|
1304
1277
|
|
|
1305
1278
|
|
|
1306
|
-
<span class="param-type"
|
|
1279
|
+
<span class="param-type">Array.<string></span>
|
|
1280
|
+
|
|
1307
1281
|
|
|
1308
1282
|
|
|
1309
1283
|
|
|
@@ -1324,15 +1298,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1324
1298
|
|
|
1325
1299
|
<td class="default">
|
|
1326
1300
|
|
|
1327
|
-
[]
|
|
1301
|
+
<code>[]</code>
|
|
1328
1302
|
|
|
1329
1303
|
</td>
|
|
1330
1304
|
|
|
1331
1305
|
|
|
1332
|
-
<td class="description last">
|
|
1333
|
-
The fields to include in the query.
|
|
1334
|
-
|
|
1335
|
-
</td>
|
|
1306
|
+
<td class="description last">The fields to include in the query.</td>
|
|
1336
1307
|
</tr>
|
|
1337
1308
|
|
|
1338
1309
|
|
|
@@ -1345,7 +1316,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1345
1316
|
<td class="type">
|
|
1346
1317
|
|
|
1347
1318
|
|
|
1348
|
-
<span class="param-type"
|
|
1319
|
+
<span class="param-type">string</span>
|
|
1320
|
+
|
|
1349
1321
|
|
|
1350
1322
|
|
|
1351
1323
|
|
|
@@ -1366,22 +1338,18 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1366
1338
|
|
|
1367
1339
|
<td class="default">
|
|
1368
1340
|
|
|
1369
|
-
""
|
|
1341
|
+
<code>""</code>
|
|
1370
1342
|
|
|
1371
1343
|
</td>
|
|
1372
1344
|
|
|
1373
1345
|
|
|
1374
|
-
<td class="description last">
|
|
1375
|
-
The field to group the results by.
|
|
1376
|
-
|
|
1377
|
-
</td>
|
|
1346
|
+
<td class="description last">The field to group the results by.</td>
|
|
1378
1347
|
</tr>
|
|
1379
1348
|
|
|
1380
1349
|
|
|
1381
1350
|
</tbody>
|
|
1382
1351
|
</table>
|
|
1383
1352
|
|
|
1384
|
-
|
|
1385
1353
|
</td>
|
|
1386
1354
|
</tr>
|
|
1387
1355
|
|
|
@@ -1402,59 +1370,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1402
1370
|
|
|
1403
1371
|
|
|
1404
1372
|
|
|
1405
|
-
|
|
1406
|
-
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1407
1376
|
|
|
1408
1377
|
|
|
1378
|
+
<div class="param-desc">
|
|
1379
|
+
- The fetched song data or null if not found.
|
|
1380
|
+
</div>
|
|
1381
|
+
|
|
1382
|
+
|
|
1409
1383
|
|
|
1410
1384
|
<dl class="param-type">
|
|
1411
1385
|
<dt>
|
|
1412
|
-
Type
|
|
1386
|
+
Type
|
|
1413
1387
|
</dt>
|
|
1414
1388
|
<dd>
|
|
1415
1389
|
|
|
1416
|
-
<span class="param-type"
|
|
1390
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1391
|
+
|
|
1417
1392
|
|
|
1418
1393
|
|
|
1419
1394
|
</dd>
|
|
1420
1395
|
</dl>
|
|
1421
1396
|
|
|
1422
|
-
|
|
1423
|
-
<div class="param-desc">
|
|
1424
|
-
- The fetched song data or null if not found.
|
|
1425
|
-
</div>
|
|
1426
|
-
|
|
1427
1397
|
|
|
1428
|
-
</div>
|
|
1429
1398
|
|
|
1430
1399
|
|
|
1431
1400
|
|
|
1432
|
-
</div>
|
|
1433
1401
|
|
|
1434
1402
|
|
|
1435
|
-
<div class="section-method">
|
|
1436
1403
|
|
|
1437
1404
|
|
|
1438
1405
|
|
|
1439
|
-
<h4 class="name" id="fetchArtists"><span class="type-signature">(async) </span>fetchArtists<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1406
|
+
<h4 class="name" id="fetchArtists"><span class="type-signature type-signature-async">(async) </span>fetchArtists<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1440
1407
|
|
|
1441
1408
|
|
|
1442
1409
|
|
|
1443
1410
|
|
|
1444
1411
|
|
|
1445
|
-
<div class="description">
|
|
1446
|
-
Fetch all artists with lessons available for a specific brand.
|
|
1447
|
-
</div>
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
1412
|
|
|
1453
1413
|
<dl class="details">
|
|
1454
|
-
|
|
1414
|
+
|
|
1415
|
+
<dt class="tag-description">Description:</dt>
|
|
1416
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all artists with lessons available for a specific brand.</li></ul></dd>
|
|
1455
1417
|
|
|
1456
1418
|
|
|
1457
1419
|
|
|
1420
|
+
<dt class="tag-source">Source:</dt>
|
|
1421
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1422
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a>
|
|
1423
|
+
</li></ul></dd>
|
|
1424
|
+
|
|
1458
1425
|
|
|
1459
1426
|
|
|
1460
1427
|
|
|
@@ -1477,10 +1444,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1477
1444
|
|
|
1478
1445
|
|
|
1479
1446
|
|
|
1480
|
-
|
|
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>
|
|
1447
|
+
|
|
1484
1448
|
|
|
1485
1449
|
|
|
1486
1450
|
|
|
@@ -1498,7 +1462,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1498
1462
|
|
|
1499
1463
|
|
|
1500
1464
|
|
|
1501
|
-
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1502
1470
|
|
|
1503
1471
|
|
|
1504
1472
|
<table class="params">
|
|
@@ -1529,7 +1497,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1529
1497
|
<td class="type">
|
|
1530
1498
|
|
|
1531
1499
|
|
|
1532
|
-
<span class="param-type"
|
|
1500
|
+
<span class="param-type">string</span>
|
|
1501
|
+
|
|
1533
1502
|
|
|
1534
1503
|
|
|
1535
1504
|
|
|
@@ -1539,10 +1508,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1539
1508
|
|
|
1540
1509
|
|
|
1541
1510
|
|
|
1542
|
-
<td class="description last">
|
|
1543
|
-
The brand for which to fetch artists.
|
|
1544
|
-
|
|
1545
|
-
</td>
|
|
1511
|
+
<td class="description last">The brand for which to fetch artists.</td>
|
|
1546
1512
|
</tr>
|
|
1547
1513
|
|
|
1548
1514
|
|
|
@@ -1562,59 +1528,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1562
1528
|
|
|
1563
1529
|
|
|
1564
1530
|
|
|
1565
|
-
|
|
1566
|
-
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1567
1534
|
|
|
1568
1535
|
|
|
1536
|
+
<div class="param-desc">
|
|
1537
|
+
- The fetched artist data or null if not found.
|
|
1538
|
+
</div>
|
|
1539
|
+
|
|
1540
|
+
|
|
1569
1541
|
|
|
1570
1542
|
<dl class="param-type">
|
|
1571
1543
|
<dt>
|
|
1572
|
-
Type
|
|
1544
|
+
Type
|
|
1573
1545
|
</dt>
|
|
1574
1546
|
<dd>
|
|
1575
1547
|
|
|
1576
|
-
<span class="param-type"
|
|
1548
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1549
|
+
|
|
1577
1550
|
|
|
1578
1551
|
|
|
1579
1552
|
</dd>
|
|
1580
1553
|
</dl>
|
|
1581
1554
|
|
|
1582
|
-
|
|
1583
|
-
<div class="param-desc">
|
|
1584
|
-
- The fetched artist data or null if not found.
|
|
1585
|
-
</div>
|
|
1586
|
-
|
|
1587
1555
|
|
|
1588
|
-
</div>
|
|
1589
1556
|
|
|
1590
1557
|
|
|
1591
1558
|
|
|
1592
|
-
</div>
|
|
1593
1559
|
|
|
1594
1560
|
|
|
1595
|
-
<div class="section-method">
|
|
1596
1561
|
|
|
1597
1562
|
|
|
1598
1563
|
|
|
1599
|
-
<h4 class="name" id="fetchByRailContentId"><span class="type-signature">(async) </span>fetchByRailContentId<span class="signature">(id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1564
|
+
<h4 class="name" id="fetchByRailContentId"><span class="type-signature type-signature-async">(async) </span>fetchByRailContentId<span class="signature">(id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1600
1565
|
|
|
1601
1566
|
|
|
1602
1567
|
|
|
1603
1568
|
|
|
1604
1569
|
|
|
1605
|
-
<div class="description">
|
|
1606
|
-
Fetch content by a specific Railcontent ID.
|
|
1607
|
-
</div>
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
1570
|
|
|
1613
1571
|
<dl class="details">
|
|
1614
|
-
|
|
1572
|
+
|
|
1573
|
+
<dt class="tag-description">Description:</dt>
|
|
1574
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch content by a specific Railcontent ID.</li></ul></dd>
|
|
1615
1575
|
|
|
1616
1576
|
|
|
1617
1577
|
|
|
1578
|
+
<dt class="tag-source">Source:</dt>
|
|
1579
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1580
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line414">line 414</a>
|
|
1581
|
+
</li></ul></dd>
|
|
1582
|
+
|
|
1618
1583
|
|
|
1619
1584
|
|
|
1620
1585
|
|
|
@@ -1637,10 +1602,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1637
1602
|
|
|
1638
1603
|
|
|
1639
1604
|
|
|
1640
|
-
|
|
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>
|
|
1605
|
+
|
|
1644
1606
|
|
|
1645
1607
|
|
|
1646
1608
|
|
|
@@ -1658,7 +1620,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1658
1620
|
|
|
1659
1621
|
|
|
1660
1622
|
|
|
1661
|
-
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1662
1628
|
|
|
1663
1629
|
|
|
1664
1630
|
<table class="params">
|
|
@@ -1689,7 +1655,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1689
1655
|
<td class="type">
|
|
1690
1656
|
|
|
1691
1657
|
|
|
1692
|
-
<span class="param-type"
|
|
1658
|
+
<span class="param-type">string</span>
|
|
1659
|
+
|
|
1693
1660
|
|
|
1694
1661
|
|
|
1695
1662
|
|
|
@@ -1699,10 +1666,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1699
1666
|
|
|
1700
1667
|
|
|
1701
1668
|
|
|
1702
|
-
<td class="description last">
|
|
1703
|
-
The Railcontent ID of the content to fetch.
|
|
1704
|
-
|
|
1705
|
-
</td>
|
|
1669
|
+
<td class="description last">The Railcontent ID of the content to fetch.</td>
|
|
1706
1670
|
</tr>
|
|
1707
1671
|
|
|
1708
1672
|
|
|
@@ -1722,59 +1686,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1722
1686
|
|
|
1723
1687
|
|
|
1724
1688
|
|
|
1725
|
-
|
|
1726
|
-
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1727
1692
|
|
|
1728
1693
|
|
|
1694
|
+
<div class="param-desc">
|
|
1695
|
+
- The fetched content data or null if not found.
|
|
1696
|
+
</div>
|
|
1697
|
+
|
|
1698
|
+
|
|
1729
1699
|
|
|
1730
1700
|
<dl class="param-type">
|
|
1731
1701
|
<dt>
|
|
1732
|
-
Type
|
|
1702
|
+
Type
|
|
1733
1703
|
</dt>
|
|
1734
1704
|
<dd>
|
|
1735
1705
|
|
|
1736
|
-
<span class="param-type"
|
|
1706
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1707
|
+
|
|
1737
1708
|
|
|
1738
1709
|
|
|
1739
1710
|
</dd>
|
|
1740
1711
|
</dl>
|
|
1741
1712
|
|
|
1742
|
-
|
|
1743
|
-
<div class="param-desc">
|
|
1744
|
-
- The fetched content data or null if not found.
|
|
1745
|
-
</div>
|
|
1746
|
-
|
|
1747
1713
|
|
|
1748
|
-
</div>
|
|
1749
1714
|
|
|
1750
1715
|
|
|
1751
1716
|
|
|
1752
|
-
</div>
|
|
1753
1717
|
|
|
1754
1718
|
|
|
1755
|
-
<div class="section-method">
|
|
1756
1719
|
|
|
1757
1720
|
|
|
1758
1721
|
|
|
1759
|
-
<h4 class="name" id="fetchByRailContentIds"><span class="type-signature">(async) </span>fetchByRailContentIds<span class="signature">(ids)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1722
|
+
<h4 class="name" id="fetchByRailContentIds"><span class="type-signature type-signature-async">(async) </span>fetchByRailContentIds<span class="signature">(ids)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1760
1723
|
|
|
1761
1724
|
|
|
1762
1725
|
|
|
1763
1726
|
|
|
1764
1727
|
|
|
1765
|
-
<div class="description">
|
|
1766
|
-
Fetch content by an array of Railcontent IDs.
|
|
1767
|
-
</div>
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
1728
|
|
|
1773
1729
|
<dl class="details">
|
|
1774
|
-
|
|
1730
|
+
|
|
1731
|
+
<dt class="tag-description">Description:</dt>
|
|
1732
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch content by an array of Railcontent IDs.</li></ul></dd>
|
|
1775
1733
|
|
|
1776
1734
|
|
|
1777
1735
|
|
|
1736
|
+
<dt class="tag-source">Source:</dt>
|
|
1737
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1738
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line434">line 434</a>
|
|
1739
|
+
</li></ul></dd>
|
|
1740
|
+
|
|
1778
1741
|
|
|
1779
1742
|
|
|
1780
1743
|
|
|
@@ -1797,10 +1760,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1797
1760
|
|
|
1798
1761
|
|
|
1799
1762
|
|
|
1800
|
-
|
|
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>
|
|
1763
|
+
|
|
1804
1764
|
|
|
1805
1765
|
|
|
1806
1766
|
|
|
@@ -1818,7 +1778,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1818
1778
|
|
|
1819
1779
|
|
|
1820
1780
|
|
|
1821
|
-
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1822
1786
|
|
|
1823
1787
|
|
|
1824
1788
|
<table class="params">
|
|
@@ -1849,7 +1813,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1849
1813
|
<td class="type">
|
|
1850
1814
|
|
|
1851
1815
|
|
|
1852
|
-
<span class="param-type"
|
|
1816
|
+
<span class="param-type">Array.<string></span>
|
|
1817
|
+
|
|
1853
1818
|
|
|
1854
1819
|
|
|
1855
1820
|
|
|
@@ -1859,10 +1824,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1859
1824
|
|
|
1860
1825
|
|
|
1861
1826
|
|
|
1862
|
-
<td class="description last">
|
|
1863
|
-
The array of Railcontent IDs of the content to fetch.
|
|
1864
|
-
|
|
1865
|
-
</td>
|
|
1827
|
+
<td class="description last">The array of Railcontent IDs of the content to fetch.</td>
|
|
1866
1828
|
</tr>
|
|
1867
1829
|
|
|
1868
1830
|
|
|
@@ -1882,59 +1844,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1882
1844
|
|
|
1883
1845
|
|
|
1884
1846
|
|
|
1885
|
-
|
|
1886
|
-
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1887
1850
|
|
|
1888
1851
|
|
|
1852
|
+
<div class="param-desc">
|
|
1853
|
+
- The fetched content data or null if not found.
|
|
1854
|
+
</div>
|
|
1855
|
+
|
|
1856
|
+
|
|
1889
1857
|
|
|
1890
1858
|
<dl class="param-type">
|
|
1891
1859
|
<dt>
|
|
1892
|
-
Type
|
|
1860
|
+
Type
|
|
1893
1861
|
</dt>
|
|
1894
1862
|
<dd>
|
|
1895
1863
|
|
|
1896
|
-
<span class="param-type"
|
|
1864
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
1865
|
+
|
|
1897
1866
|
|
|
1898
1867
|
|
|
1899
1868
|
</dd>
|
|
1900
1869
|
</dl>
|
|
1901
1870
|
|
|
1902
|
-
|
|
1903
|
-
<div class="param-desc">
|
|
1904
|
-
- The fetched content data or null if not found.
|
|
1905
|
-
</div>
|
|
1906
|
-
|
|
1907
1871
|
|
|
1908
|
-
</div>
|
|
1909
1872
|
|
|
1910
1873
|
|
|
1911
1874
|
|
|
1912
|
-
</div>
|
|
1913
1875
|
|
|
1914
1876
|
|
|
1915
|
-
<div class="section-method">
|
|
1916
1877
|
|
|
1917
1878
|
|
|
1918
1879
|
|
|
1919
|
-
<h4 class="name" id="fetchChildren"><span class="type-signature">(async) </span>fetchChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1880
|
+
<h4 class="name" id="fetchChildren"><span class="type-signature type-signature-async">(async) </span>fetchChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1920
1881
|
|
|
1921
1882
|
|
|
1922
1883
|
|
|
1923
1884
|
|
|
1924
1885
|
|
|
1925
|
-
<div class="description">
|
|
1926
|
-
Fetch children content by Railcontent ID.
|
|
1927
|
-
</div>
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
1886
|
|
|
1933
1887
|
<dl class="details">
|
|
1934
|
-
|
|
1888
|
+
|
|
1889
|
+
<dt class="tag-description">Description:</dt>
|
|
1890
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch children content by Railcontent ID.</li></ul></dd>
|
|
1935
1891
|
|
|
1936
1892
|
|
|
1937
1893
|
|
|
1894
|
+
<dt class="tag-source">Source:</dt>
|
|
1895
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1896
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line649">line 649</a>
|
|
1897
|
+
</li></ul></dd>
|
|
1898
|
+
|
|
1938
1899
|
|
|
1939
1900
|
|
|
1940
1901
|
|
|
@@ -1957,10 +1918,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1957
1918
|
|
|
1958
1919
|
|
|
1959
1920
|
|
|
1960
|
-
|
|
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>
|
|
1921
|
+
|
|
1964
1922
|
|
|
1965
1923
|
|
|
1966
1924
|
|
|
@@ -1978,7 +1936,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1978
1936
|
|
|
1979
1937
|
|
|
1980
1938
|
|
|
1981
|
-
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1982
1944
|
|
|
1983
1945
|
|
|
1984
1946
|
<table class="params">
|
|
@@ -2009,7 +1971,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2009
1971
|
<td class="type">
|
|
2010
1972
|
|
|
2011
1973
|
|
|
2012
|
-
<span class="param-type"
|
|
1974
|
+
<span class="param-type">string</span>
|
|
1975
|
+
|
|
2013
1976
|
|
|
2014
1977
|
|
|
2015
1978
|
|
|
@@ -2019,10 +1982,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2019
1982
|
|
|
2020
1983
|
|
|
2021
1984
|
|
|
2022
|
-
<td class="description last">
|
|
2023
|
-
The Railcontent ID of the parent content.
|
|
2024
|
-
|
|
2025
|
-
</td>
|
|
1985
|
+
<td class="description last">The Railcontent ID of the parent content.</td>
|
|
2026
1986
|
</tr>
|
|
2027
1987
|
|
|
2028
1988
|
|
|
@@ -2042,59 +2002,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2042
2002
|
|
|
2043
2003
|
|
|
2044
2004
|
|
|
2045
|
-
|
|
2046
|
-
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2047
2008
|
|
|
2048
2009
|
|
|
2010
|
+
<div class="param-desc">
|
|
2011
|
+
- The fetched children content data or null if not found.
|
|
2012
|
+
</div>
|
|
2013
|
+
|
|
2014
|
+
|
|
2049
2015
|
|
|
2050
2016
|
<dl class="param-type">
|
|
2051
2017
|
<dt>
|
|
2052
|
-
Type
|
|
2018
|
+
Type
|
|
2053
2019
|
</dt>
|
|
2054
2020
|
<dd>
|
|
2055
2021
|
|
|
2056
|
-
<span class="param-type"
|
|
2022
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
2023
|
+
|
|
2057
2024
|
|
|
2058
2025
|
|
|
2059
2026
|
</dd>
|
|
2060
2027
|
</dl>
|
|
2061
2028
|
|
|
2062
|
-
|
|
2063
|
-
<div class="param-desc">
|
|
2064
|
-
- The fetched children content data or null if not found.
|
|
2065
|
-
</div>
|
|
2066
|
-
|
|
2067
2029
|
|
|
2068
|
-
</div>
|
|
2069
2030
|
|
|
2070
2031
|
|
|
2071
2032
|
|
|
2072
|
-
</div>
|
|
2073
2033
|
|
|
2074
2034
|
|
|
2075
|
-
<div class="section-method">
|
|
2076
2035
|
|
|
2077
2036
|
|
|
2078
2037
|
|
|
2079
|
-
<h4 class="name" id="fetchLessonContent"><span class="type-signature">(async) </span>fetchLessonContent<span class="signature">(railContentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2038
|
+
<h4 class="name" id="fetchLessonContent"><span class="type-signature type-signature-async">(async) </span>fetchLessonContent<span class="signature">(railContentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2080
2039
|
|
|
2081
2040
|
|
|
2082
2041
|
|
|
2083
2042
|
|
|
2084
2043
|
|
|
2085
|
-
<div class="description">
|
|
2086
|
-
Fetch the page data for a specific lesson by Railcontent ID.
|
|
2087
|
-
</div>
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
2044
|
|
|
2093
2045
|
<dl class="details">
|
|
2094
|
-
|
|
2046
|
+
|
|
2047
|
+
<dt class="tag-description">Description:</dt>
|
|
2048
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the page data for a specific lesson by Railcontent ID.</li></ul></dd>
|
|
2095
2049
|
|
|
2096
2050
|
|
|
2097
2051
|
|
|
2052
|
+
<dt class="tag-source">Source:</dt>
|
|
2053
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2054
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line722">line 722</a>
|
|
2055
|
+
</li></ul></dd>
|
|
2056
|
+
|
|
2098
2057
|
|
|
2099
2058
|
|
|
2100
2059
|
|
|
@@ -2117,10 +2076,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2117
2076
|
|
|
2118
2077
|
|
|
2119
2078
|
|
|
2120
|
-
|
|
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>
|
|
2079
|
+
|
|
2124
2080
|
|
|
2125
2081
|
|
|
2126
2082
|
|
|
@@ -2138,7 +2094,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2138
2094
|
|
|
2139
2095
|
|
|
2140
2096
|
|
|
2141
|
-
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2142
2102
|
|
|
2143
2103
|
|
|
2144
2104
|
<table class="params">
|
|
@@ -2169,7 +2129,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2169
2129
|
<td class="type">
|
|
2170
2130
|
|
|
2171
2131
|
|
|
2172
|
-
<span class="param-type"
|
|
2132
|
+
<span class="param-type">string</span>
|
|
2133
|
+
|
|
2173
2134
|
|
|
2174
2135
|
|
|
2175
2136
|
|
|
@@ -2179,10 +2140,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2179
2140
|
|
|
2180
2141
|
|
|
2181
2142
|
|
|
2182
|
-
<td class="description last">
|
|
2183
|
-
The Railcontent ID of the current lesson.
|
|
2184
|
-
|
|
2185
|
-
</td>
|
|
2143
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
2186
2144
|
</tr>
|
|
2187
2145
|
|
|
2188
2146
|
|
|
@@ -2202,59 +2160,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2202
2160
|
|
|
2203
2161
|
|
|
2204
2162
|
|
|
2205
|
-
|
|
2206
|
-
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2207
2166
|
|
|
2208
2167
|
|
|
2168
|
+
<div class="param-desc">
|
|
2169
|
+
- The fetched page data or null if found.
|
|
2170
|
+
</div>
|
|
2171
|
+
|
|
2172
|
+
|
|
2209
2173
|
|
|
2210
2174
|
<dl class="param-type">
|
|
2211
2175
|
<dt>
|
|
2212
|
-
Type
|
|
2176
|
+
Type
|
|
2213
2177
|
</dt>
|
|
2214
2178
|
<dd>
|
|
2215
2179
|
|
|
2216
|
-
<span class="param-type"
|
|
2180
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2181
|
+
|
|
2217
2182
|
|
|
2218
2183
|
|
|
2219
2184
|
</dd>
|
|
2220
2185
|
</dl>
|
|
2221
2186
|
|
|
2222
|
-
|
|
2223
|
-
<div class="param-desc">
|
|
2224
|
-
- The fetched page data or null if found.
|
|
2225
|
-
</div>
|
|
2226
|
-
|
|
2227
2187
|
|
|
2228
|
-
</div>
|
|
2229
2188
|
|
|
2230
2189
|
|
|
2231
2190
|
|
|
2232
|
-
</div>
|
|
2233
2191
|
|
|
2234
2192
|
|
|
2235
|
-
<div class="section-method">
|
|
2236
2193
|
|
|
2237
2194
|
|
|
2238
2195
|
|
|
2239
|
-
<h4 class="name" id="fetchMethodChildren"><span class="type-signature">(async) </span>fetchMethodChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2196
|
+
<h4 class="name" id="fetchMethodChildren"><span class="type-signature type-signature-async">(async) </span>fetchMethodChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2240
2197
|
|
|
2241
2198
|
|
|
2242
2199
|
|
|
2243
2200
|
|
|
2244
2201
|
|
|
2245
|
-
<div class="description">
|
|
2246
|
-
Fetch all children of a specific method by Railcontent ID.
|
|
2247
|
-
</div>
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
2202
|
|
|
2253
2203
|
<dl class="details">
|
|
2254
|
-
|
|
2204
|
+
|
|
2205
|
+
<dt class="tag-description">Description:</dt>
|
|
2206
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all children of a specific method by Railcontent ID.</li></ul></dd>
|
|
2255
2207
|
|
|
2256
2208
|
|
|
2257
2209
|
|
|
2210
|
+
<dt class="tag-source">Source:</dt>
|
|
2211
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2212
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line691">line 691</a>
|
|
2213
|
+
</li></ul></dd>
|
|
2214
|
+
|
|
2258
2215
|
|
|
2259
2216
|
|
|
2260
2217
|
|
|
@@ -2277,10 +2234,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2277
2234
|
|
|
2278
2235
|
|
|
2279
2236
|
|
|
2280
|
-
|
|
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>
|
|
2237
|
+
|
|
2284
2238
|
|
|
2285
2239
|
|
|
2286
2240
|
|
|
@@ -2298,7 +2252,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2298
2252
|
|
|
2299
2253
|
|
|
2300
2254
|
|
|
2301
|
-
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
|
|
2258
|
+
|
|
2259
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2302
2260
|
|
|
2303
2261
|
|
|
2304
2262
|
<table class="params">
|
|
@@ -2329,7 +2287,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2329
2287
|
<td class="type">
|
|
2330
2288
|
|
|
2331
2289
|
|
|
2332
|
-
<span class="param-type"
|
|
2290
|
+
<span class="param-type">string</span>
|
|
2291
|
+
|
|
2333
2292
|
|
|
2334
2293
|
|
|
2335
2294
|
|
|
@@ -2339,10 +2298,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2339
2298
|
|
|
2340
2299
|
|
|
2341
2300
|
|
|
2342
|
-
<td class="description last">
|
|
2343
|
-
The Railcontent ID of the method.
|
|
2344
|
-
|
|
2345
|
-
</td>
|
|
2301
|
+
<td class="description last">The Railcontent ID of the method.</td>
|
|
2346
2302
|
</tr>
|
|
2347
2303
|
|
|
2348
2304
|
|
|
@@ -2362,59 +2318,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2362
2318
|
|
|
2363
2319
|
|
|
2364
2320
|
|
|
2365
|
-
|
|
2366
|
-
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2367
2324
|
|
|
2368
2325
|
|
|
2326
|
+
<div class="param-desc">
|
|
2327
|
+
- The fetched children data or null if not found.
|
|
2328
|
+
</div>
|
|
2329
|
+
|
|
2330
|
+
|
|
2369
2331
|
|
|
2370
2332
|
<dl class="param-type">
|
|
2371
2333
|
<dt>
|
|
2372
|
-
Type
|
|
2334
|
+
Type
|
|
2373
2335
|
</dt>
|
|
2374
2336
|
<dd>
|
|
2375
2337
|
|
|
2376
|
-
<span class="param-type"
|
|
2338
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
2339
|
+
|
|
2377
2340
|
|
|
2378
2341
|
|
|
2379
2342
|
</dd>
|
|
2380
2343
|
</dl>
|
|
2381
2344
|
|
|
2382
|
-
|
|
2383
|
-
<div class="param-desc">
|
|
2384
|
-
- The fetched children data or null if not found.
|
|
2385
|
-
</div>
|
|
2386
|
-
|
|
2387
2345
|
|
|
2388
|
-
</div>
|
|
2389
2346
|
|
|
2390
2347
|
|
|
2391
2348
|
|
|
2392
|
-
</div>
|
|
2393
2349
|
|
|
2394
2350
|
|
|
2395
|
-
<div class="section-method">
|
|
2396
2351
|
|
|
2397
2352
|
|
|
2398
2353
|
|
|
2399
|
-
<h4 class="name" id="fetchMethodNextLesson"><span class="type-signature">(async) </span>fetchMethodNextLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2354
|
+
<h4 class="name" id="fetchMethodNextLesson"><span class="type-signature type-signature-async">(async) </span>fetchMethodNextLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2400
2355
|
|
|
2401
2356
|
|
|
2402
2357
|
|
|
2403
2358
|
|
|
2404
2359
|
|
|
2405
|
-
<div class="description">
|
|
2406
|
-
Fetch the next lesson for a specific method by Railcontent ID.
|
|
2407
|
-
</div>
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
2360
|
|
|
2413
2361
|
<dl class="details">
|
|
2414
|
-
|
|
2362
|
+
|
|
2363
|
+
<dt class="tag-description">Description:</dt>
|
|
2364
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next lesson for a specific method by Railcontent ID.</li></ul></dd>
|
|
2415
2365
|
|
|
2416
2366
|
|
|
2417
2367
|
|
|
2368
|
+
<dt class="tag-source">Source:</dt>
|
|
2369
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2370
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line670">line 670</a>
|
|
2371
|
+
</li></ul></dd>
|
|
2372
|
+
|
|
2418
2373
|
|
|
2419
2374
|
|
|
2420
2375
|
|
|
@@ -2437,10 +2392,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2437
2392
|
|
|
2438
2393
|
|
|
2439
2394
|
|
|
2440
|
-
|
|
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>
|
|
2395
|
+
|
|
2444
2396
|
|
|
2445
2397
|
|
|
2446
2398
|
|
|
@@ -2458,7 +2410,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2458
2410
|
|
|
2459
2411
|
|
|
2460
2412
|
|
|
2461
|
-
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2462
2418
|
|
|
2463
2419
|
|
|
2464
2420
|
<table class="params">
|
|
@@ -2489,7 +2445,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2489
2445
|
<td class="type">
|
|
2490
2446
|
|
|
2491
2447
|
|
|
2492
|
-
<span class="param-type"
|
|
2448
|
+
<span class="param-type">string</span>
|
|
2449
|
+
|
|
2493
2450
|
|
|
2494
2451
|
|
|
2495
2452
|
|
|
@@ -2499,10 +2456,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2499
2456
|
|
|
2500
2457
|
|
|
2501
2458
|
|
|
2502
|
-
<td class="description last">
|
|
2503
|
-
The Railcontent ID of the current lesson.
|
|
2504
|
-
|
|
2505
|
-
</td>
|
|
2459
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
2506
2460
|
</tr>
|
|
2507
2461
|
|
|
2508
2462
|
|
|
@@ -2522,59 +2476,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2522
2476
|
|
|
2523
2477
|
|
|
2524
2478
|
|
|
2525
|
-
|
|
2526
|
-
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2527
2482
|
|
|
2528
2483
|
|
|
2484
|
+
<div class="param-desc">
|
|
2485
|
+
- The fetched next lesson data or null if not found.
|
|
2486
|
+
</div>
|
|
2487
|
+
|
|
2488
|
+
|
|
2529
2489
|
|
|
2530
2490
|
<dl class="param-type">
|
|
2531
2491
|
<dt>
|
|
2532
|
-
Type
|
|
2492
|
+
Type
|
|
2533
2493
|
</dt>
|
|
2534
2494
|
<dd>
|
|
2535
2495
|
|
|
2536
|
-
<span class="param-type"
|
|
2496
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2497
|
+
|
|
2537
2498
|
|
|
2538
2499
|
|
|
2539
2500
|
</dd>
|
|
2540
2501
|
</dl>
|
|
2541
2502
|
|
|
2542
|
-
|
|
2543
|
-
<div class="param-desc">
|
|
2544
|
-
- The fetched next lesson data or null if not found.
|
|
2545
|
-
</div>
|
|
2546
|
-
|
|
2547
2503
|
|
|
2548
|
-
</div>
|
|
2549
2504
|
|
|
2550
2505
|
|
|
2551
2506
|
|
|
2552
|
-
</div>
|
|
2553
2507
|
|
|
2554
2508
|
|
|
2555
|
-
<div class="section-method">
|
|
2556
2509
|
|
|
2557
2510
|
|
|
2558
2511
|
|
|
2559
|
-
<h4 class="name" id="fetchNewReleases"><span class="type-signature">(async) </span>fetchNewReleases<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2512
|
+
<h4 class="name" id="fetchNewReleases"><span class="type-signature type-signature-async">(async) </span>fetchNewReleases<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2560
2513
|
|
|
2561
2514
|
|
|
2562
2515
|
|
|
2563
2516
|
|
|
2564
2517
|
|
|
2565
|
-
<div class="description">
|
|
2566
|
-
Fetch the latest new releases for a specific brand.
|
|
2567
|
-
</div>
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
2518
|
|
|
2573
2519
|
<dl class="details">
|
|
2574
|
-
|
|
2520
|
+
|
|
2521
|
+
<dt class="tag-description">Description:</dt>
|
|
2522
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the latest new releases for a specific brand.</li></ul></dd>
|
|
2575
2523
|
|
|
2576
2524
|
|
|
2577
2525
|
|
|
2526
|
+
<dt class="tag-source">Source:</dt>
|
|
2527
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2528
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line356">line 356</a>
|
|
2529
|
+
</li></ul></dd>
|
|
2530
|
+
|
|
2578
2531
|
|
|
2579
2532
|
|
|
2580
2533
|
|
|
@@ -2597,10 +2550,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2597
2550
|
|
|
2598
2551
|
|
|
2599
2552
|
|
|
2600
|
-
|
|
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>
|
|
2553
|
+
|
|
2604
2554
|
|
|
2605
2555
|
|
|
2606
2556
|
|
|
@@ -2618,7 +2568,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2618
2568
|
|
|
2619
2569
|
|
|
2620
2570
|
|
|
2621
|
-
|
|
2571
|
+
|
|
2572
|
+
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2622
2576
|
|
|
2623
2577
|
|
|
2624
2578
|
<table class="params">
|
|
@@ -2649,7 +2603,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2649
2603
|
<td class="type">
|
|
2650
2604
|
|
|
2651
2605
|
|
|
2652
|
-
<span class="param-type"
|
|
2606
|
+
<span class="param-type">string</span>
|
|
2607
|
+
|
|
2653
2608
|
|
|
2654
2609
|
|
|
2655
2610
|
|
|
@@ -2659,10 +2614,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2659
2614
|
|
|
2660
2615
|
|
|
2661
2616
|
|
|
2662
|
-
<td class="description last">
|
|
2663
|
-
The brand for which to fetch new releases.
|
|
2664
|
-
|
|
2665
|
-
</td>
|
|
2617
|
+
<td class="description last">The brand for which to fetch new releases.</td>
|
|
2666
2618
|
</tr>
|
|
2667
2619
|
|
|
2668
2620
|
|
|
@@ -2682,59 +2634,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2682
2634
|
|
|
2683
2635
|
|
|
2684
2636
|
|
|
2685
|
-
<div class="section-returns">
|
|
2686
|
-
<h5>Returns:</h5>
|
|
2687
2637
|
|
|
2688
|
-
|
|
2638
|
+
|
|
2639
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2640
|
+
|
|
2641
|
+
|
|
2642
|
+
<div class="param-desc">
|
|
2643
|
+
- The fetched new releases data or null if not found.
|
|
2644
|
+
</div>
|
|
2645
|
+
|
|
2646
|
+
|
|
2689
2647
|
|
|
2690
2648
|
<dl class="param-type">
|
|
2691
2649
|
<dt>
|
|
2692
|
-
Type
|
|
2650
|
+
Type
|
|
2693
2651
|
</dt>
|
|
2694
2652
|
<dd>
|
|
2695
2653
|
|
|
2696
|
-
<span class="param-type"
|
|
2654
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2655
|
+
|
|
2697
2656
|
|
|
2698
2657
|
|
|
2699
2658
|
</dd>
|
|
2700
2659
|
</dl>
|
|
2701
2660
|
|
|
2702
|
-
|
|
2703
|
-
<div class="param-desc">
|
|
2704
|
-
- The fetched new releases data or null if not found.
|
|
2705
|
-
</div>
|
|
2706
|
-
|
|
2707
2661
|
|
|
2708
|
-
</div>
|
|
2709
2662
|
|
|
2710
2663
|
|
|
2711
2664
|
|
|
2712
|
-
</div>
|
|
2713
2665
|
|
|
2714
2666
|
|
|
2715
|
-
<div class="section-method">
|
|
2716
2667
|
|
|
2717
2668
|
|
|
2718
2669
|
|
|
2719
|
-
<h4 class="name" id="fetchNextPreviousLesson"><span class="type-signature">(async) </span>fetchNextPreviousLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2670
|
+
<h4 class="name" id="fetchNextPreviousLesson"><span class="type-signature type-signature-async">(async) </span>fetchNextPreviousLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2720
2671
|
|
|
2721
2672
|
|
|
2722
2673
|
|
|
2723
2674
|
|
|
2724
2675
|
|
|
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
2676
|
|
|
2733
2677
|
<dl class="details">
|
|
2734
|
-
|
|
2678
|
+
|
|
2679
|
+
<dt class="tag-description">Description:</dt>
|
|
2680
|
+
<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
2681
|
|
|
2736
2682
|
|
|
2737
2683
|
|
|
2684
|
+
<dt class="tag-source">Source:</dt>
|
|
2685
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2686
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line701">line 701</a>
|
|
2687
|
+
</li></ul></dd>
|
|
2688
|
+
|
|
2738
2689
|
|
|
2739
2690
|
|
|
2740
2691
|
|
|
@@ -2757,10 +2708,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2757
2708
|
|
|
2758
2709
|
|
|
2759
2710
|
|
|
2760
|
-
|
|
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>
|
|
2711
|
+
|
|
2764
2712
|
|
|
2765
2713
|
|
|
2766
2714
|
|
|
@@ -2778,7 +2726,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2778
2726
|
|
|
2779
2727
|
|
|
2780
2728
|
|
|
2781
|
-
|
|
2729
|
+
|
|
2730
|
+
|
|
2731
|
+
|
|
2732
|
+
|
|
2733
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2782
2734
|
|
|
2783
2735
|
|
|
2784
2736
|
<table class="params">
|
|
@@ -2809,7 +2761,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2809
2761
|
<td class="type">
|
|
2810
2762
|
|
|
2811
2763
|
|
|
2812
|
-
<span class="param-type"
|
|
2764
|
+
<span class="param-type">string</span>
|
|
2765
|
+
|
|
2813
2766
|
|
|
2814
2767
|
|
|
2815
2768
|
|
|
@@ -2819,10 +2772,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2819
2772
|
|
|
2820
2773
|
|
|
2821
2774
|
|
|
2822
|
-
<td class="description last">
|
|
2823
|
-
The Railcontent ID of the current lesson.
|
|
2824
|
-
|
|
2825
|
-
</td>
|
|
2775
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
2826
2776
|
</tr>
|
|
2827
2777
|
|
|
2828
2778
|
|
|
@@ -2842,59 +2792,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2842
2792
|
|
|
2843
2793
|
|
|
2844
2794
|
|
|
2845
|
-
|
|
2846
|
-
|
|
2795
|
+
|
|
2796
|
+
|
|
2797
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2847
2798
|
|
|
2848
2799
|
|
|
2800
|
+
<div class="param-desc">
|
|
2801
|
+
- The fetched next and previous lesson data or null if found.
|
|
2802
|
+
</div>
|
|
2803
|
+
|
|
2804
|
+
|
|
2849
2805
|
|
|
2850
2806
|
<dl class="param-type">
|
|
2851
2807
|
<dt>
|
|
2852
|
-
Type
|
|
2808
|
+
Type
|
|
2853
2809
|
</dt>
|
|
2854
2810
|
<dd>
|
|
2855
2811
|
|
|
2856
|
-
<span class="param-type"
|
|
2812
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2813
|
+
|
|
2857
2814
|
|
|
2858
2815
|
|
|
2859
2816
|
</dd>
|
|
2860
2817
|
</dl>
|
|
2861
2818
|
|
|
2862
|
-
|
|
2863
|
-
<div class="param-desc">
|
|
2864
|
-
- The fetched next and previous lesson data or null if found.
|
|
2865
|
-
</div>
|
|
2866
|
-
|
|
2867
2819
|
|
|
2868
|
-
</div>
|
|
2869
2820
|
|
|
2870
2821
|
|
|
2871
2822
|
|
|
2872
|
-
</div>
|
|
2873
2823
|
|
|
2874
2824
|
|
|
2875
|
-
<div class="section-method">
|
|
2876
2825
|
|
|
2877
2826
|
|
|
2878
2827
|
|
|
2879
|
-
<h4 class="name" id="fetchPackAll"><span class="type-signature">(async) </span>fetchPackAll<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2828
|
+
<h4 class="name" id="fetchPackAll"><span class="type-signature type-signature-async">(async) </span>fetchPackAll<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2880
2829
|
|
|
2881
2830
|
|
|
2882
2831
|
|
|
2883
2832
|
|
|
2884
2833
|
|
|
2885
|
-
<div class="description">
|
|
2886
|
-
Fetch all content for a specific pack by Railcontent ID.
|
|
2887
|
-
</div>
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
2834
|
|
|
2893
2835
|
<dl class="details">
|
|
2894
|
-
|
|
2836
|
+
|
|
2837
|
+
<dt class="tag-description">Description:</dt>
|
|
2838
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all content for a specific pack by Railcontent ID.</li></ul></dd>
|
|
2895
2839
|
|
|
2896
2840
|
|
|
2897
2841
|
|
|
2842
|
+
<dt class="tag-source">Source:</dt>
|
|
2843
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2844
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a>
|
|
2845
|
+
</li></ul></dd>
|
|
2846
|
+
|
|
2898
2847
|
|
|
2899
2848
|
|
|
2900
2849
|
|
|
@@ -2917,10 +2866,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2917
2866
|
|
|
2918
2867
|
|
|
2919
2868
|
|
|
2920
|
-
|
|
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>
|
|
2869
|
+
|
|
2924
2870
|
|
|
2925
2871
|
|
|
2926
2872
|
|
|
@@ -2938,7 +2884,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2938
2884
|
|
|
2939
2885
|
|
|
2940
2886
|
|
|
2941
|
-
|
|
2887
|
+
|
|
2888
|
+
|
|
2889
|
+
|
|
2890
|
+
|
|
2891
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2942
2892
|
|
|
2943
2893
|
|
|
2944
2894
|
<table class="params">
|
|
@@ -2969,7 +2919,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2969
2919
|
<td class="type">
|
|
2970
2920
|
|
|
2971
2921
|
|
|
2972
|
-
<span class="param-type"
|
|
2922
|
+
<span class="param-type">string</span>
|
|
2923
|
+
|
|
2973
2924
|
|
|
2974
2925
|
|
|
2975
2926
|
|
|
@@ -2979,10 +2930,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2979
2930
|
|
|
2980
2931
|
|
|
2981
2932
|
|
|
2982
|
-
<td class="description last">
|
|
2983
|
-
The Railcontent ID of the pack.
|
|
2984
|
-
|
|
2985
|
-
</td>
|
|
2933
|
+
<td class="description last">The Railcontent ID of the pack.</td>
|
|
2986
2934
|
</tr>
|
|
2987
2935
|
|
|
2988
2936
|
|
|
@@ -3002,59 +2950,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3002
2950
|
|
|
3003
2951
|
|
|
3004
2952
|
|
|
3005
|
-
|
|
3006
|
-
|
|
2953
|
+
|
|
2954
|
+
|
|
2955
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3007
2956
|
|
|
3008
2957
|
|
|
2958
|
+
<div class="param-desc">
|
|
2959
|
+
- The fetched pack content data or null if not found.
|
|
2960
|
+
</div>
|
|
2961
|
+
|
|
2962
|
+
|
|
3009
2963
|
|
|
3010
2964
|
<dl class="param-type">
|
|
3011
2965
|
<dt>
|
|
3012
|
-
Type
|
|
2966
|
+
Type
|
|
3013
2967
|
</dt>
|
|
3014
2968
|
<dd>
|
|
3015
2969
|
|
|
3016
|
-
<span class="param-type"
|
|
2970
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
2971
|
+
|
|
3017
2972
|
|
|
3018
2973
|
|
|
3019
2974
|
</dd>
|
|
3020
2975
|
</dl>
|
|
3021
2976
|
|
|
3022
|
-
|
|
3023
|
-
<div class="param-desc">
|
|
3024
|
-
- The fetched pack content data or null if not found.
|
|
3025
|
-
</div>
|
|
3026
|
-
|
|
3027
2977
|
|
|
3028
|
-
</div>
|
|
3029
2978
|
|
|
3030
2979
|
|
|
3031
2980
|
|
|
3032
|
-
</div>
|
|
3033
2981
|
|
|
3034
2982
|
|
|
3035
|
-
<div class="section-method">
|
|
3036
2983
|
|
|
3037
2984
|
|
|
3038
2985
|
|
|
3039
|
-
<h4 class="name" id="fetchPackChildren"><span class="type-signature">(async) </span>fetchPackChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2986
|
+
<h4 class="name" id="fetchPackChildren"><span class="type-signature type-signature-async">(async) </span>fetchPackChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
3040
2987
|
|
|
3041
2988
|
|
|
3042
2989
|
|
|
3043
2990
|
|
|
3044
2991
|
|
|
3045
|
-
<div class="description">
|
|
3046
|
-
Fetch all children of a specific pack by Railcontent ID.
|
|
3047
|
-
</div>
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
2992
|
|
|
3053
2993
|
<dl class="details">
|
|
3054
|
-
|
|
2994
|
+
|
|
2995
|
+
<dt class="tag-description">Description:</dt>
|
|
2996
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all children of a specific pack by Railcontent ID.</li></ul></dd>
|
|
3055
2997
|
|
|
3056
2998
|
|
|
3057
2999
|
|
|
3000
|
+
<dt class="tag-source">Source:</dt>
|
|
3001
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3002
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line797">line 797</a>
|
|
3003
|
+
</li></ul></dd>
|
|
3004
|
+
|
|
3058
3005
|
|
|
3059
3006
|
|
|
3060
3007
|
|
|
@@ -3077,10 +3024,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3077
3024
|
|
|
3078
3025
|
|
|
3079
3026
|
|
|
3080
|
-
|
|
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>
|
|
3027
|
+
|
|
3084
3028
|
|
|
3085
3029
|
|
|
3086
3030
|
|
|
@@ -3098,7 +3042,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3098
3042
|
|
|
3099
3043
|
|
|
3100
3044
|
|
|
3101
|
-
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
|
|
3049
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3102
3050
|
|
|
3103
3051
|
|
|
3104
3052
|
<table class="params">
|
|
@@ -3129,7 +3077,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3129
3077
|
<td class="type">
|
|
3130
3078
|
|
|
3131
3079
|
|
|
3132
|
-
<span class="param-type"
|
|
3080
|
+
<span class="param-type">string</span>
|
|
3081
|
+
|
|
3133
3082
|
|
|
3134
3083
|
|
|
3135
3084
|
|
|
@@ -3139,10 +3088,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3139
3088
|
|
|
3140
3089
|
|
|
3141
3090
|
|
|
3142
|
-
<td class="description last">
|
|
3143
|
-
The Railcontent ID of the pack.
|
|
3144
|
-
|
|
3145
|
-
</td>
|
|
3091
|
+
<td class="description last">The Railcontent ID of the pack.</td>
|
|
3146
3092
|
</tr>
|
|
3147
3093
|
|
|
3148
3094
|
|
|
@@ -3162,59 +3108,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3162
3108
|
|
|
3163
3109
|
|
|
3164
3110
|
|
|
3165
|
-
|
|
3166
|
-
|
|
3111
|
+
|
|
3112
|
+
|
|
3113
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3167
3114
|
|
|
3168
3115
|
|
|
3116
|
+
<div class="param-desc">
|
|
3117
|
+
- The fetched pack children data or null if not found.
|
|
3118
|
+
</div>
|
|
3119
|
+
|
|
3120
|
+
|
|
3169
3121
|
|
|
3170
3122
|
<dl class="param-type">
|
|
3171
3123
|
<dt>
|
|
3172
|
-
Type
|
|
3124
|
+
Type
|
|
3173
3125
|
</dt>
|
|
3174
3126
|
<dd>
|
|
3175
3127
|
|
|
3176
|
-
<span class="param-type"
|
|
3128
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
3129
|
+
|
|
3177
3130
|
|
|
3178
3131
|
|
|
3179
3132
|
</dd>
|
|
3180
3133
|
</dl>
|
|
3181
3134
|
|
|
3182
|
-
|
|
3183
|
-
<div class="param-desc">
|
|
3184
|
-
- The fetched pack children data or null if not found.
|
|
3185
|
-
</div>
|
|
3186
|
-
|
|
3187
3135
|
|
|
3188
|
-
</div>
|
|
3189
3136
|
|
|
3190
3137
|
|
|
3191
3138
|
|
|
3192
|
-
</div>
|
|
3193
3139
|
|
|
3194
3140
|
|
|
3195
|
-
<div class="section-method">
|
|
3196
3141
|
|
|
3197
3142
|
|
|
3198
3143
|
|
|
3199
|
-
<h4 class="name" id="fetchRelatedLessons"><span class="type-signature">(async) </span>fetchRelatedLessons<span class="signature">(railContentId, brand)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
3144
|
+
<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"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
3200
3145
|
|
|
3201
3146
|
|
|
3202
3147
|
|
|
3203
3148
|
|
|
3204
3149
|
|
|
3205
|
-
<div class="description">
|
|
3206
|
-
Fetch related lessons for a specific lesson by RailContent ID and type.
|
|
3207
|
-
</div>
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
3150
|
|
|
3213
3151
|
<dl class="details">
|
|
3214
|
-
|
|
3152
|
+
|
|
3153
|
+
<dt class="tag-description">Description:</dt>
|
|
3154
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch related lessons for a specific lesson by RailContent ID and type.</li></ul></dd>
|
|
3215
3155
|
|
|
3216
3156
|
|
|
3217
3157
|
|
|
3158
|
+
<dt class="tag-source">Source:</dt>
|
|
3159
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3160
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line755">line 755</a>
|
|
3161
|
+
</li></ul></dd>
|
|
3162
|
+
|
|
3218
3163
|
|
|
3219
3164
|
|
|
3220
3165
|
|
|
@@ -3237,10 +3182,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3237
3182
|
|
|
3238
3183
|
|
|
3239
3184
|
|
|
3240
|
-
|
|
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>
|
|
3185
|
+
|
|
3244
3186
|
|
|
3245
3187
|
|
|
3246
3188
|
|
|
@@ -3258,7 +3200,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3258
3200
|
|
|
3259
3201
|
|
|
3260
3202
|
|
|
3261
|
-
|
|
3203
|
+
|
|
3204
|
+
|
|
3205
|
+
|
|
3206
|
+
|
|
3207
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3262
3208
|
|
|
3263
3209
|
|
|
3264
3210
|
<table class="params">
|
|
@@ -3289,7 +3235,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3289
3235
|
<td class="type">
|
|
3290
3236
|
|
|
3291
3237
|
|
|
3292
|
-
<span class="param-type"
|
|
3238
|
+
<span class="param-type">string</span>
|
|
3239
|
+
|
|
3293
3240
|
|
|
3294
3241
|
|
|
3295
3242
|
|
|
@@ -3299,10 +3246,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3299
3246
|
|
|
3300
3247
|
|
|
3301
3248
|
|
|
3302
|
-
<td class="description last">
|
|
3303
|
-
The RailContent ID of the current lesson.
|
|
3304
|
-
|
|
3305
|
-
</td>
|
|
3249
|
+
<td class="description last">The RailContent ID of the current lesson.</td>
|
|
3306
3250
|
</tr>
|
|
3307
3251
|
|
|
3308
3252
|
|
|
@@ -3315,7 +3259,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3315
3259
|
<td class="type">
|
|
3316
3260
|
|
|
3317
3261
|
|
|
3318
|
-
<span class="param-type"
|
|
3262
|
+
<span class="param-type">string</span>
|
|
3263
|
+
|
|
3319
3264
|
|
|
3320
3265
|
|
|
3321
3266
|
|
|
@@ -3325,10 +3270,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3325
3270
|
|
|
3326
3271
|
|
|
3327
3272
|
|
|
3328
|
-
<td class="description last">
|
|
3329
|
-
The current brand.
|
|
3330
|
-
|
|
3331
|
-
</td>
|
|
3273
|
+
<td class="description last">The current brand.</td>
|
|
3332
3274
|
</tr>
|
|
3333
3275
|
|
|
3334
3276
|
|
|
@@ -3348,59 +3290,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3348
3290
|
|
|
3349
3291
|
|
|
3350
3292
|
|
|
3351
|
-
|
|
3352
|
-
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3353
3296
|
|
|
3354
3297
|
|
|
3298
|
+
<div class="param-desc">
|
|
3299
|
+
- The fetched related lessons data or null if not found.
|
|
3300
|
+
</div>
|
|
3301
|
+
|
|
3302
|
+
|
|
3355
3303
|
|
|
3356
3304
|
<dl class="param-type">
|
|
3357
3305
|
<dt>
|
|
3358
|
-
Type
|
|
3306
|
+
Type
|
|
3359
3307
|
</dt>
|
|
3360
3308
|
<dd>
|
|
3361
3309
|
|
|
3362
|
-
<span class="param-type"
|
|
3310
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
3311
|
+
|
|
3363
3312
|
|
|
3364
3313
|
|
|
3365
3314
|
</dd>
|
|
3366
3315
|
</dl>
|
|
3367
3316
|
|
|
3368
|
-
|
|
3369
|
-
<div class="param-desc">
|
|
3370
|
-
- The fetched related lessons data or null if not found.
|
|
3371
|
-
</div>
|
|
3372
|
-
|
|
3373
3317
|
|
|
3374
|
-
</div>
|
|
3375
3318
|
|
|
3376
3319
|
|
|
3377
3320
|
|
|
3378
|
-
</div>
|
|
3379
3321
|
|
|
3380
3322
|
|
|
3381
|
-
<div class="section-method">
|
|
3382
3323
|
|
|
3383
3324
|
|
|
3384
3325
|
|
|
3385
|
-
<h4 class="name" id="fetchRelatedSongs"><span class="type-signature">(async) </span>fetchRelatedSongs<span class="signature">(brand, songId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3326
|
+
<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"> → {Promise.<(Object|null)>}</span></h4>
|
|
3386
3327
|
|
|
3387
3328
|
|
|
3388
3329
|
|
|
3389
3330
|
|
|
3390
3331
|
|
|
3391
|
-
<div class="description">
|
|
3392
|
-
Fetch related songs for a specific brand and song ID.
|
|
3393
|
-
</div>
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
3332
|
|
|
3399
3333
|
<dl class="details">
|
|
3400
|
-
|
|
3334
|
+
|
|
3335
|
+
<dt class="tag-description">Description:</dt>
|
|
3336
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch related songs for a specific brand and song ID.</li></ul></dd>
|
|
3401
3337
|
|
|
3402
3338
|
|
|
3403
3339
|
|
|
3340
|
+
<dt class="tag-source">Source:</dt>
|
|
3341
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3342
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
|
|
3343
|
+
</li></ul></dd>
|
|
3344
|
+
|
|
3404
3345
|
|
|
3405
3346
|
|
|
3406
3347
|
|
|
@@ -3423,10 +3364,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3423
3364
|
|
|
3424
3365
|
|
|
3425
3366
|
|
|
3426
|
-
|
|
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>
|
|
3367
|
+
|
|
3430
3368
|
|
|
3431
3369
|
|
|
3432
3370
|
|
|
@@ -3444,7 +3382,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3444
3382
|
|
|
3445
3383
|
|
|
3446
3384
|
|
|
3447
|
-
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3448
3390
|
|
|
3449
3391
|
|
|
3450
3392
|
<table class="params">
|
|
@@ -3475,7 +3417,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3475
3417
|
<td class="type">
|
|
3476
3418
|
|
|
3477
3419
|
|
|
3478
|
-
<span class="param-type"
|
|
3420
|
+
<span class="param-type">string</span>
|
|
3421
|
+
|
|
3479
3422
|
|
|
3480
3423
|
|
|
3481
3424
|
|
|
@@ -3485,10 +3428,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3485
3428
|
|
|
3486
3429
|
|
|
3487
3430
|
|
|
3488
|
-
<td class="description last">
|
|
3489
|
-
The brand for which to fetch related songs.
|
|
3490
|
-
|
|
3491
|
-
</td>
|
|
3431
|
+
<td class="description last">The brand for which to fetch related songs.</td>
|
|
3492
3432
|
</tr>
|
|
3493
3433
|
|
|
3494
3434
|
|
|
@@ -3501,7 +3441,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3501
3441
|
<td class="type">
|
|
3502
3442
|
|
|
3503
3443
|
|
|
3504
|
-
<span class="param-type"
|
|
3444
|
+
<span class="param-type">string</span>
|
|
3445
|
+
|
|
3505
3446
|
|
|
3506
3447
|
|
|
3507
3448
|
|
|
@@ -3511,10 +3452,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3511
3452
|
|
|
3512
3453
|
|
|
3513
3454
|
|
|
3514
|
-
<td class="description last">
|
|
3515
|
-
The ID of the song to find related songs for.
|
|
3516
|
-
|
|
3517
|
-
</td>
|
|
3455
|
+
<td class="description last">The ID of the song to find related songs for.</td>
|
|
3518
3456
|
</tr>
|
|
3519
3457
|
|
|
3520
3458
|
|
|
@@ -3534,59 +3472,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3534
3472
|
|
|
3535
3473
|
|
|
3536
3474
|
|
|
3537
|
-
|
|
3538
|
-
|
|
3475
|
+
|
|
3476
|
+
|
|
3477
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3539
3478
|
|
|
3540
3479
|
|
|
3480
|
+
<div class="param-desc">
|
|
3481
|
+
- The fetched related songs data or null if not found.
|
|
3482
|
+
</div>
|
|
3483
|
+
|
|
3484
|
+
|
|
3541
3485
|
|
|
3542
3486
|
<dl class="param-type">
|
|
3543
3487
|
<dt>
|
|
3544
|
-
Type
|
|
3488
|
+
Type
|
|
3545
3489
|
</dt>
|
|
3546
3490
|
<dd>
|
|
3547
3491
|
|
|
3548
|
-
<span class="param-type"
|
|
3492
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
3493
|
+
|
|
3549
3494
|
|
|
3550
3495
|
|
|
3551
3496
|
</dd>
|
|
3552
3497
|
</dl>
|
|
3553
3498
|
|
|
3554
|
-
|
|
3555
|
-
<div class="param-desc">
|
|
3556
|
-
- The fetched related songs data or null if not found.
|
|
3557
|
-
</div>
|
|
3558
|
-
|
|
3559
3499
|
|
|
3560
|
-
</div>
|
|
3561
3500
|
|
|
3562
3501
|
|
|
3563
3502
|
|
|
3564
|
-
</div>
|
|
3565
3503
|
|
|
3566
3504
|
|
|
3567
|
-
<div class="section-method">
|
|
3568
3505
|
|
|
3569
3506
|
|
|
3570
3507
|
|
|
3571
|
-
<h4 class="name" id="fetchSanity"><span class="type-signature">(async) </span>fetchSanity<span class="signature">(query, isList)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3508
|
+
<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"> → {Promise.<(Object|null)>}</span></h4>
|
|
3572
3509
|
|
|
3573
3510
|
|
|
3574
3511
|
|
|
3575
3512
|
|
|
3576
3513
|
|
|
3577
|
-
<div class="description">
|
|
3578
|
-
Fetch data from the Sanity API based on a provided query.
|
|
3579
|
-
</div>
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
|
|
3584
3514
|
|
|
3585
3515
|
<dl class="details">
|
|
3586
|
-
|
|
3516
|
+
|
|
3517
|
+
<dt class="tag-description">Description:</dt>
|
|
3518
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch data from the Sanity API based on a provided query.</li></ul></dd>
|
|
3587
3519
|
|
|
3588
3520
|
|
|
3589
3521
|
|
|
3522
|
+
<dt class="tag-source">Source:</dt>
|
|
3523
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3524
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line807">line 807</a>
|
|
3525
|
+
</li></ul></dd>
|
|
3526
|
+
|
|
3590
3527
|
|
|
3591
3528
|
|
|
3592
3529
|
|
|
@@ -3609,10 +3546,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3609
3546
|
|
|
3610
3547
|
|
|
3611
3548
|
|
|
3612
|
-
|
|
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>
|
|
3549
|
+
|
|
3616
3550
|
|
|
3617
3551
|
|
|
3618
3552
|
|
|
@@ -3630,7 +3564,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3630
3564
|
|
|
3631
3565
|
|
|
3632
3566
|
|
|
3633
|
-
|
|
3567
|
+
|
|
3568
|
+
|
|
3569
|
+
|
|
3570
|
+
|
|
3571
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3634
3572
|
|
|
3635
3573
|
|
|
3636
3574
|
<table class="params">
|
|
@@ -3661,7 +3599,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3661
3599
|
<td class="type">
|
|
3662
3600
|
|
|
3663
3601
|
|
|
3664
|
-
<span class="param-type"
|
|
3602
|
+
<span class="param-type">string</span>
|
|
3603
|
+
|
|
3665
3604
|
|
|
3666
3605
|
|
|
3667
3606
|
|
|
@@ -3671,10 +3610,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3671
3610
|
|
|
3672
3611
|
|
|
3673
3612
|
|
|
3674
|
-
<td class="description last">
|
|
3675
|
-
The GROQ query to execute against the Sanity API.
|
|
3676
|
-
|
|
3677
|
-
</td>
|
|
3613
|
+
<td class="description last">The GROQ query to execute against the Sanity API.</td>
|
|
3678
3614
|
</tr>
|
|
3679
3615
|
|
|
3680
3616
|
|
|
@@ -3687,7 +3623,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3687
3623
|
<td class="type">
|
|
3688
3624
|
|
|
3689
3625
|
|
|
3690
|
-
<span class="param-type"
|
|
3626
|
+
<span class="param-type">boolean</span>
|
|
3627
|
+
|
|
3691
3628
|
|
|
3692
3629
|
|
|
3693
3630
|
|
|
@@ -3697,10 +3634,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3697
3634
|
|
|
3698
3635
|
|
|
3699
3636
|
|
|
3700
|
-
<td class="description last">
|
|
3701
|
-
Whether to return an array or single result
|
|
3702
|
-
|
|
3703
|
-
</td>
|
|
3637
|
+
<td class="description last">Whether to return an array or single result</td>
|
|
3704
3638
|
</tr>
|
|
3705
3639
|
|
|
3706
3640
|
|
|
@@ -3720,59 +3654,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3720
3654
|
|
|
3721
3655
|
|
|
3722
3656
|
|
|
3723
|
-
|
|
3724
|
-
|
|
3657
|
+
|
|
3658
|
+
|
|
3659
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3725
3660
|
|
|
3726
3661
|
|
|
3662
|
+
<div class="param-desc">
|
|
3663
|
+
- The first result from the query, or null if an error occurs or no results are found.
|
|
3664
|
+
</div>
|
|
3665
|
+
|
|
3666
|
+
|
|
3727
3667
|
|
|
3728
3668
|
<dl class="param-type">
|
|
3729
3669
|
<dt>
|
|
3730
|
-
Type
|
|
3670
|
+
Type
|
|
3731
3671
|
</dt>
|
|
3732
3672
|
<dd>
|
|
3733
3673
|
|
|
3734
|
-
<span class="param-type"
|
|
3674
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
3675
|
+
|
|
3735
3676
|
|
|
3736
3677
|
|
|
3737
3678
|
</dd>
|
|
3738
3679
|
</dl>
|
|
3739
3680
|
|
|
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
3681
|
|
|
3746
|
-
</div>
|
|
3747
3682
|
|
|
3748
3683
|
|
|
3749
3684
|
|
|
3750
|
-
</div>
|
|
3751
3685
|
|
|
3752
3686
|
|
|
3753
|
-
<div class="section-method">
|
|
3754
3687
|
|
|
3755
3688
|
|
|
3756
3689
|
|
|
3757
|
-
<h4 class="name" id="fetchSongArtistCount"><span class="type-signature">(async) </span>fetchSongArtistCount<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(int|null)>}</span></h4>
|
|
3690
|
+
<h4 class="name" id="fetchSongArtistCount"><span class="type-signature type-signature-async">(async) </span>fetchSongArtistCount<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(int|null)>}</span></h4>
|
|
3758
3691
|
|
|
3759
3692
|
|
|
3760
3693
|
|
|
3761
3694
|
|
|
3762
3695
|
|
|
3763
|
-
<div class="description">
|
|
3764
|
-
Fetch current number of artists for songs within a brand.
|
|
3765
|
-
</div>
|
|
3766
|
-
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
3696
|
|
|
3771
3697
|
<dl class="details">
|
|
3772
|
-
|
|
3698
|
+
|
|
3699
|
+
<dt class="tag-description">Description:</dt>
|
|
3700
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch current number of artists for songs within a brand.</li></ul></dd>
|
|
3773
3701
|
|
|
3774
3702
|
|
|
3775
3703
|
|
|
3704
|
+
<dt class="tag-source">Source:</dt>
|
|
3705
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3706
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line73">line 73</a>
|
|
3707
|
+
</li></ul></dd>
|
|
3708
|
+
|
|
3776
3709
|
|
|
3777
3710
|
|
|
3778
3711
|
|
|
@@ -3795,10 +3728,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3795
3728
|
|
|
3796
3729
|
|
|
3797
3730
|
|
|
3798
|
-
|
|
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>
|
|
3731
|
+
|
|
3802
3732
|
|
|
3803
3733
|
|
|
3804
3734
|
|
|
@@ -3816,7 +3746,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3816
3746
|
|
|
3817
3747
|
|
|
3818
3748
|
|
|
3819
|
-
|
|
3749
|
+
|
|
3750
|
+
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3820
3754
|
|
|
3821
3755
|
|
|
3822
3756
|
<table class="params">
|
|
@@ -3847,7 +3781,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3847
3781
|
<td class="type">
|
|
3848
3782
|
|
|
3849
3783
|
|
|
3850
|
-
<span class="param-type"
|
|
3784
|
+
<span class="param-type">string</span>
|
|
3785
|
+
|
|
3851
3786
|
|
|
3852
3787
|
|
|
3853
3788
|
|
|
@@ -3857,10 +3792,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3857
3792
|
|
|
3858
3793
|
|
|
3859
3794
|
|
|
3860
|
-
<td class="description last">
|
|
3861
|
-
The current brand.
|
|
3862
|
-
|
|
3863
|
-
</td>
|
|
3795
|
+
<td class="description last">The current brand.</td>
|
|
3864
3796
|
</tr>
|
|
3865
3797
|
|
|
3866
3798
|
|
|
@@ -3880,57 +3812,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3880
3812
|
|
|
3881
3813
|
|
|
3882
3814
|
|
|
3883
|
-
|
|
3884
|
-
|
|
3815
|
+
|
|
3816
|
+
|
|
3817
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3885
3818
|
|
|
3886
3819
|
|
|
3820
|
+
<div class="param-desc">
|
|
3821
|
+
- The fetched count of artists.
|
|
3822
|
+
</div>
|
|
3823
|
+
|
|
3824
|
+
|
|
3887
3825
|
|
|
3888
3826
|
<dl class="param-type">
|
|
3889
3827
|
<dt>
|
|
3890
|
-
Type
|
|
3828
|
+
Type
|
|
3891
3829
|
</dt>
|
|
3892
3830
|
<dd>
|
|
3893
3831
|
|
|
3894
|
-
<span class="param-type"
|
|
3832
|
+
<span class="param-type">Promise.<(int|null)></span>
|
|
3833
|
+
|
|
3895
3834
|
|
|
3896
3835
|
|
|
3897
3836
|
</dd>
|
|
3898
3837
|
</dl>
|
|
3899
3838
|
|
|
3900
|
-
|
|
3901
|
-
<div class="param-desc">
|
|
3902
|
-
- The fetched count of artists.
|
|
3903
|
-
</div>
|
|
3904
|
-
|
|
3905
3839
|
|
|
3906
|
-
</div>
|
|
3907
3840
|
|
|
3908
3841
|
|
|
3909
3842
|
|
|
3910
|
-
</div>
|
|
3911
3843
|
|
|
3912
3844
|
|
|
3913
|
-
<div class="section-method">
|
|
3914
3845
|
|
|
3915
3846
|
|
|
3916
3847
|
|
|
3917
|
-
<h4 class="name" id="fetchSongById"><span class="type-signature">(async) </span>fetchSongById<span class="signature">(documentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3848
|
+
<h4 class="name" id="fetchSongById"><span class="type-signature type-signature-async">(async) </span>fetchSongById<span class="signature">(documentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3918
3849
|
|
|
3919
3850
|
|
|
3920
3851
|
|
|
3921
3852
|
|
|
3922
3853
|
|
|
3923
|
-
<div class="description">
|
|
3924
|
-
Fetch a song by its document ID from Sanity.
|
|
3925
|
-
</div>
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
3854
|
|
|
3931
3855
|
<dl class="details">
|
|
3856
|
+
|
|
3857
|
+
<dt class="tag-description">Description:</dt>
|
|
3858
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch a song by its document ID from Sanity.</li></ul></dd>
|
|
3859
|
+
|
|
3932
3860
|
|
|
3933
3861
|
|
|
3862
|
+
<dt class="tag-source">Source:</dt>
|
|
3863
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3864
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line34">line 34</a>
|
|
3865
|
+
</li></ul></dd>
|
|
3866
|
+
|
|
3934
3867
|
|
|
3935
3868
|
|
|
3936
3869
|
|
|
@@ -3954,11 +3887,6 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3954
3887
|
|
|
3955
3888
|
|
|
3956
3889
|
|
|
3957
|
-
|
|
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>
|
|
3962
3890
|
|
|
3963
3891
|
|
|
3964
3892
|
|
|
@@ -3976,7 +3904,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3976
3904
|
|
|
3977
3905
|
|
|
3978
3906
|
|
|
3979
|
-
|
|
3907
|
+
|
|
3908
|
+
|
|
3909
|
+
|
|
3910
|
+
|
|
3911
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3980
3912
|
|
|
3981
3913
|
|
|
3982
3914
|
<table class="params">
|
|
@@ -4007,7 +3939,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4007
3939
|
<td class="type">
|
|
4008
3940
|
|
|
4009
3941
|
|
|
4010
|
-
<span class="param-type"
|
|
3942
|
+
<span class="param-type">string</span>
|
|
3943
|
+
|
|
4011
3944
|
|
|
4012
3945
|
|
|
4013
3946
|
|
|
@@ -4017,10 +3950,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4017
3950
|
|
|
4018
3951
|
|
|
4019
3952
|
|
|
4020
|
-
<td class="description last">
|
|
4021
|
-
The ID of the document to fetch.
|
|
4022
|
-
|
|
4023
|
-
</td>
|
|
3953
|
+
<td class="description last">The ID of the document to fetch.</td>
|
|
4024
3954
|
</tr>
|
|
4025
3955
|
|
|
4026
3956
|
|
|
@@ -4040,59 +3970,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4040
3970
|
|
|
4041
3971
|
|
|
4042
3972
|
|
|
4043
|
-
|
|
4044
|
-
|
|
3973
|
+
|
|
3974
|
+
|
|
3975
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4045
3976
|
|
|
4046
3977
|
|
|
3978
|
+
<div class="param-desc">
|
|
3979
|
+
- The fetched song data or null if not found.
|
|
3980
|
+
</div>
|
|
3981
|
+
|
|
3982
|
+
|
|
4047
3983
|
|
|
4048
3984
|
<dl class="param-type">
|
|
4049
3985
|
<dt>
|
|
4050
|
-
Type
|
|
3986
|
+
Type
|
|
4051
3987
|
</dt>
|
|
4052
3988
|
<dd>
|
|
4053
3989
|
|
|
4054
|
-
<span class="param-type"
|
|
3990
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
3991
|
+
|
|
4055
3992
|
|
|
4056
3993
|
|
|
4057
3994
|
</dd>
|
|
4058
3995
|
</dl>
|
|
4059
3996
|
|
|
4060
|
-
|
|
4061
|
-
<div class="param-desc">
|
|
4062
|
-
- The fetched song data or null if not found.
|
|
4063
|
-
</div>
|
|
4064
|
-
|
|
4065
3997
|
|
|
4066
|
-
</div>
|
|
4067
3998
|
|
|
4068
3999
|
|
|
4069
4000
|
|
|
4070
|
-
</div>
|
|
4071
4001
|
|
|
4072
4002
|
|
|
4073
|
-
<div class="section-method">
|
|
4074
4003
|
|
|
4075
4004
|
|
|
4076
4005
|
|
|
4077
|
-
<h4 class="name" id="fetchSongCount"><span class="type-signature">(async) </span>fetchSongCount<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(number|null)>}</span></h4>
|
|
4006
|
+
<h4 class="name" id="fetchSongCount"><span class="type-signature type-signature-async">(async) </span>fetchSongCount<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(number|null)>}</span></h4>
|
|
4078
4007
|
|
|
4079
4008
|
|
|
4080
4009
|
|
|
4081
4010
|
|
|
4082
4011
|
|
|
4083
|
-
<div class="description">
|
|
4084
|
-
Fetch the total count of songs for a specific brand.
|
|
4085
|
-
</div>
|
|
4086
|
-
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
|
|
4090
4012
|
|
|
4091
4013
|
<dl class="details">
|
|
4092
|
-
|
|
4014
|
+
|
|
4015
|
+
<dt class="tag-description">Description:</dt>
|
|
4016
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the total count of songs for a specific brand.</li></ul></dd>
|
|
4093
4017
|
|
|
4094
4018
|
|
|
4095
4019
|
|
|
4020
|
+
<dt class="tag-source">Source:</dt>
|
|
4021
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4022
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line326">line 326</a>
|
|
4023
|
+
</li></ul></dd>
|
|
4024
|
+
|
|
4096
4025
|
|
|
4097
4026
|
|
|
4098
4027
|
|
|
@@ -4115,10 +4044,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4115
4044
|
|
|
4116
4045
|
|
|
4117
4046
|
|
|
4118
|
-
|
|
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>
|
|
4047
|
+
|
|
4122
4048
|
|
|
4123
4049
|
|
|
4124
4050
|
|
|
@@ -4136,7 +4062,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4136
4062
|
|
|
4137
4063
|
|
|
4138
4064
|
|
|
4139
|
-
|
|
4065
|
+
|
|
4066
|
+
|
|
4067
|
+
|
|
4068
|
+
|
|
4069
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4140
4070
|
|
|
4141
4071
|
|
|
4142
4072
|
<table class="params">
|
|
@@ -4167,7 +4097,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4167
4097
|
<td class="type">
|
|
4168
4098
|
|
|
4169
4099
|
|
|
4170
|
-
<span class="param-type"
|
|
4100
|
+
<span class="param-type">string</span>
|
|
4101
|
+
|
|
4171
4102
|
|
|
4172
4103
|
|
|
4173
4104
|
|
|
@@ -4177,10 +4108,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4177
4108
|
|
|
4178
4109
|
|
|
4179
4110
|
|
|
4180
|
-
<td class="description last">
|
|
4181
|
-
The brand for which to fetch the song count.
|
|
4182
|
-
|
|
4183
|
-
</td>
|
|
4111
|
+
<td class="description last">The brand for which to fetch the song count.</td>
|
|
4184
4112
|
</tr>
|
|
4185
4113
|
|
|
4186
4114
|
|
|
@@ -4200,59 +4128,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4200
4128
|
|
|
4201
4129
|
|
|
4202
4130
|
|
|
4203
|
-
|
|
4204
|
-
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4205
4134
|
|
|
4206
4135
|
|
|
4136
|
+
<div class="param-desc">
|
|
4137
|
+
- The total count of songs or null if an error occurs.
|
|
4138
|
+
</div>
|
|
4139
|
+
|
|
4140
|
+
|
|
4207
4141
|
|
|
4208
4142
|
<dl class="param-type">
|
|
4209
4143
|
<dt>
|
|
4210
|
-
Type
|
|
4144
|
+
Type
|
|
4211
4145
|
</dt>
|
|
4212
4146
|
<dd>
|
|
4213
4147
|
|
|
4214
|
-
<span class="param-type"
|
|
4148
|
+
<span class="param-type">Promise.<(number|null)></span>
|
|
4149
|
+
|
|
4215
4150
|
|
|
4216
4151
|
|
|
4217
4152
|
</dd>
|
|
4218
4153
|
</dl>
|
|
4219
4154
|
|
|
4220
|
-
|
|
4221
|
-
<div class="param-desc">
|
|
4222
|
-
- The total count of songs or null if an error occurs.
|
|
4223
|
-
</div>
|
|
4224
|
-
|
|
4225
4155
|
|
|
4226
|
-
</div>
|
|
4227
4156
|
|
|
4228
4157
|
|
|
4229
4158
|
|
|
4230
|
-
</div>
|
|
4231
4159
|
|
|
4232
4160
|
|
|
4233
|
-
<div class="section-method">
|
|
4234
4161
|
|
|
4235
4162
|
|
|
4236
4163
|
|
|
4237
|
-
<h4 class="name" id="fetchSongFilterOptions"><span class="type-signature">(async) </span>fetchSongFilterOptions<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4164
|
+
<h4 class="name" id="fetchSongFilterOptions"><span class="type-signature type-signature-async">(async) </span>fetchSongFilterOptions<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4238
4165
|
|
|
4239
4166
|
|
|
4240
4167
|
|
|
4241
4168
|
|
|
4242
4169
|
|
|
4243
|
-
<div class="description">
|
|
4244
|
-
Fetch filter options for a specific brand.
|
|
4245
|
-
</div>
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
4170
|
|
|
4251
4171
|
<dl class="details">
|
|
4252
|
-
|
|
4172
|
+
|
|
4173
|
+
<dt class="tag-description">Description:</dt>
|
|
4174
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch filter options for a specific brand.</li></ul></dd>
|
|
4253
4175
|
|
|
4254
4176
|
|
|
4255
4177
|
|
|
4178
|
+
<dt class="tag-source">Source:</dt>
|
|
4179
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4180
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line297">line 297</a>
|
|
4181
|
+
</li></ul></dd>
|
|
4182
|
+
|
|
4256
4183
|
|
|
4257
4184
|
|
|
4258
4185
|
|
|
@@ -4275,10 +4202,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4275
4202
|
|
|
4276
4203
|
|
|
4277
4204
|
|
|
4278
|
-
|
|
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>
|
|
4205
|
+
|
|
4282
4206
|
|
|
4283
4207
|
|
|
4284
4208
|
|
|
@@ -4296,7 +4220,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4296
4220
|
|
|
4297
4221
|
|
|
4298
4222
|
|
|
4299
|
-
|
|
4223
|
+
|
|
4224
|
+
|
|
4225
|
+
|
|
4226
|
+
|
|
4227
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4300
4228
|
|
|
4301
4229
|
|
|
4302
4230
|
<table class="params">
|
|
@@ -4327,7 +4255,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4327
4255
|
<td class="type">
|
|
4328
4256
|
|
|
4329
4257
|
|
|
4330
|
-
<span class="param-type"
|
|
4258
|
+
<span class="param-type">string</span>
|
|
4259
|
+
|
|
4331
4260
|
|
|
4332
4261
|
|
|
4333
4262
|
|
|
@@ -4337,10 +4266,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4337
4266
|
|
|
4338
4267
|
|
|
4339
4268
|
|
|
4340
|
-
<td class="description last">
|
|
4341
|
-
The brand for which to fetch filter options.
|
|
4342
|
-
|
|
4343
|
-
</td>
|
|
4269
|
+
<td class="description last">The brand for which to fetch filter options.</td>
|
|
4344
4270
|
</tr>
|
|
4345
4271
|
|
|
4346
4272
|
|
|
@@ -4360,59 +4286,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4360
4286
|
|
|
4361
4287
|
|
|
4362
4288
|
|
|
4363
|
-
|
|
4364
|
-
|
|
4289
|
+
|
|
4290
|
+
|
|
4291
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4365
4292
|
|
|
4366
4293
|
|
|
4294
|
+
<div class="param-desc">
|
|
4295
|
+
- The fetched filter options or null if not found.
|
|
4296
|
+
</div>
|
|
4297
|
+
|
|
4298
|
+
|
|
4367
4299
|
|
|
4368
4300
|
<dl class="param-type">
|
|
4369
4301
|
<dt>
|
|
4370
|
-
Type
|
|
4302
|
+
Type
|
|
4371
4303
|
</dt>
|
|
4372
4304
|
<dd>
|
|
4373
4305
|
|
|
4374
|
-
<span class="param-type"
|
|
4306
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4307
|
+
|
|
4375
4308
|
|
|
4376
4309
|
|
|
4377
4310
|
</dd>
|
|
4378
4311
|
</dl>
|
|
4379
4312
|
|
|
4380
|
-
|
|
4381
|
-
<div class="param-desc">
|
|
4382
|
-
- The fetched filter options or null if not found.
|
|
4383
|
-
</div>
|
|
4384
|
-
|
|
4385
4313
|
|
|
4386
|
-
</div>
|
|
4387
4314
|
|
|
4388
4315
|
|
|
4389
4316
|
|
|
4390
|
-
</div>
|
|
4391
4317
|
|
|
4392
4318
|
|
|
4393
|
-
<div class="section-method">
|
|
4394
4319
|
|
|
4395
4320
|
|
|
4396
4321
|
|
|
4397
|
-
<h4 class="name" id="fetchUpcomingEvents"><span class="type-signature">(async) </span>fetchUpcomingEvents<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4322
|
+
<h4 class="name" id="fetchUpcomingEvents"><span class="type-signature type-signature-async">(async) </span>fetchUpcomingEvents<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4398
4323
|
|
|
4399
4324
|
|
|
4400
4325
|
|
|
4401
4326
|
|
|
4402
4327
|
|
|
4403
|
-
<div class="description">
|
|
4404
|
-
Fetch upcoming events for a specific brand.
|
|
4405
|
-
</div>
|
|
4406
|
-
|
|
4407
|
-
|
|
4408
|
-
|
|
4409
|
-
|
|
4410
4328
|
|
|
4411
4329
|
<dl class="details">
|
|
4412
|
-
|
|
4330
|
+
|
|
4331
|
+
<dt class="tag-description">Description:</dt>
|
|
4332
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch upcoming events for a specific brand.</li></ul></dd>
|
|
4413
4333
|
|
|
4414
4334
|
|
|
4415
4335
|
|
|
4336
|
+
<dt class="tag-source">Source:</dt>
|
|
4337
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4338
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line384">line 384</a>
|
|
4339
|
+
</li></ul></dd>
|
|
4340
|
+
|
|
4416
4341
|
|
|
4417
4342
|
|
|
4418
4343
|
|
|
@@ -4435,10 +4360,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4435
4360
|
|
|
4436
4361
|
|
|
4437
4362
|
|
|
4438
|
-
|
|
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>
|
|
4363
|
+
|
|
4442
4364
|
|
|
4443
4365
|
|
|
4444
4366
|
|
|
@@ -4456,7 +4378,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4456
4378
|
|
|
4457
4379
|
|
|
4458
4380
|
|
|
4459
|
-
|
|
4381
|
+
|
|
4382
|
+
|
|
4383
|
+
|
|
4384
|
+
|
|
4385
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4460
4386
|
|
|
4461
4387
|
|
|
4462
4388
|
<table class="params">
|
|
@@ -4487,7 +4413,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4487
4413
|
<td class="type">
|
|
4488
4414
|
|
|
4489
4415
|
|
|
4490
|
-
<span class="param-type"
|
|
4416
|
+
<span class="param-type">string</span>
|
|
4417
|
+
|
|
4491
4418
|
|
|
4492
4419
|
|
|
4493
4420
|
|
|
@@ -4497,10 +4424,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4497
4424
|
|
|
4498
4425
|
|
|
4499
4426
|
|
|
4500
|
-
<td class="description last">
|
|
4501
|
-
The brand for which to fetch upcoming events.
|
|
4502
|
-
|
|
4503
|
-
</td>
|
|
4427
|
+
<td class="description last">The brand for which to fetch upcoming events.</td>
|
|
4504
4428
|
</tr>
|
|
4505
4429
|
|
|
4506
4430
|
|
|
@@ -4520,59 +4444,58 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4520
4444
|
|
|
4521
4445
|
|
|
4522
4446
|
|
|
4523
|
-
|
|
4524
|
-
|
|
4447
|
+
|
|
4448
|
+
|
|
4449
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4525
4450
|
|
|
4526
4451
|
|
|
4452
|
+
<div class="param-desc">
|
|
4453
|
+
- The fetched upcoming events data or null if not found.
|
|
4454
|
+
</div>
|
|
4455
|
+
|
|
4456
|
+
|
|
4527
4457
|
|
|
4528
4458
|
<dl class="param-type">
|
|
4529
4459
|
<dt>
|
|
4530
|
-
Type
|
|
4460
|
+
Type
|
|
4531
4461
|
</dt>
|
|
4532
4462
|
<dd>
|
|
4533
4463
|
|
|
4534
|
-
<span class="param-type"
|
|
4464
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4465
|
+
|
|
4535
4466
|
|
|
4536
4467
|
|
|
4537
4468
|
</dd>
|
|
4538
4469
|
</dl>
|
|
4539
4470
|
|
|
4540
|
-
|
|
4541
|
-
<div class="param-desc">
|
|
4542
|
-
- The fetched upcoming events data or null if not found.
|
|
4543
|
-
</div>
|
|
4544
|
-
|
|
4545
4471
|
|
|
4546
|
-
</div>
|
|
4547
4472
|
|
|
4548
4473
|
|
|
4549
4474
|
|
|
4550
|
-
</div>
|
|
4551
4475
|
|
|
4552
4476
|
|
|
4553
|
-
<div class="section-method">
|
|
4554
4477
|
|
|
4555
4478
|
|
|
4556
4479
|
|
|
4557
|
-
<h4 class="name" id="fetchWorkouts"><span class="type-signature">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4480
|
+
<h4 class="name" id="fetchWorkouts"><span class="type-signature type-signature-async">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4558
4481
|
|
|
4559
4482
|
|
|
4560
4483
|
|
|
4561
4484
|
|
|
4562
4485
|
|
|
4563
|
-
<div class="description">
|
|
4564
|
-
Fetch the latest workouts for the home page of a specific brand.
|
|
4565
|
-
</div>
|
|
4566
|
-
|
|
4567
|
-
|
|
4568
|
-
|
|
4569
|
-
|
|
4570
4486
|
|
|
4571
4487
|
<dl class="details">
|
|
4572
|
-
|
|
4488
|
+
|
|
4489
|
+
<dt class="tag-description">Description:</dt>
|
|
4490
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the latest workouts for the home page of a specific brand.</li></ul></dd>
|
|
4573
4491
|
|
|
4574
4492
|
|
|
4575
4493
|
|
|
4494
|
+
<dt class="tag-source">Source:</dt>
|
|
4495
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4496
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line336">line 336</a>
|
|
4497
|
+
</li></ul></dd>
|
|
4498
|
+
|
|
4576
4499
|
|
|
4577
4500
|
|
|
4578
4501
|
|
|
@@ -4595,10 +4518,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4595
4518
|
|
|
4596
4519
|
|
|
4597
4520
|
|
|
4598
|
-
|
|
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>
|
|
4521
|
+
|
|
4602
4522
|
|
|
4603
4523
|
|
|
4604
4524
|
|
|
@@ -4616,7 +4536,11 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4616
4536
|
|
|
4617
4537
|
|
|
4618
4538
|
|
|
4619
|
-
|
|
4539
|
+
|
|
4540
|
+
|
|
4541
|
+
|
|
4542
|
+
|
|
4543
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4620
4544
|
|
|
4621
4545
|
|
|
4622
4546
|
<table class="params">
|
|
@@ -4647,7 +4571,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4647
4571
|
<td class="type">
|
|
4648
4572
|
|
|
4649
4573
|
|
|
4650
|
-
<span class="param-type"
|
|
4574
|
+
<span class="param-type">string</span>
|
|
4575
|
+
|
|
4651
4576
|
|
|
4652
4577
|
|
|
4653
4578
|
|
|
@@ -4657,10 +4582,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4657
4582
|
|
|
4658
4583
|
|
|
4659
4584
|
|
|
4660
|
-
<td class="description last">
|
|
4661
|
-
The brand for which to fetch workouts.
|
|
4662
|
-
|
|
4663
|
-
</td>
|
|
4585
|
+
<td class="description last">The brand for which to fetch workouts.</td>
|
|
4664
4586
|
</tr>
|
|
4665
4587
|
|
|
4666
4588
|
|
|
@@ -4680,37 +4602,36 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4680
4602
|
|
|
4681
4603
|
|
|
4682
4604
|
|
|
4683
|
-
|
|
4684
|
-
|
|
4605
|
+
|
|
4606
|
+
|
|
4607
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4685
4608
|
|
|
4686
4609
|
|
|
4610
|
+
<div class="param-desc">
|
|
4611
|
+
- The fetched workout data or null if not found.
|
|
4612
|
+
</div>
|
|
4613
|
+
|
|
4614
|
+
|
|
4687
4615
|
|
|
4688
4616
|
<dl class="param-type">
|
|
4689
4617
|
<dt>
|
|
4690
|
-
Type
|
|
4618
|
+
Type
|
|
4691
4619
|
</dt>
|
|
4692
4620
|
<dd>
|
|
4693
4621
|
|
|
4694
|
-
<span class="param-type"
|
|
4622
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4623
|
+
|
|
4695
4624
|
|
|
4696
4625
|
|
|
4697
4626
|
</dd>
|
|
4698
4627
|
</dl>
|
|
4699
4628
|
|
|
4700
|
-
|
|
4701
|
-
<div class="param-desc">
|
|
4702
|
-
- The fetched workout data or null if not found.
|
|
4703
|
-
</div>
|
|
4704
|
-
|
|
4705
4629
|
|
|
4706
|
-
</div>
|
|
4707
4630
|
|
|
4708
4631
|
|
|
4709
4632
|
|
|
4710
|
-
</div>
|
|
4711
4633
|
|
|
4712
4634
|
|
|
4713
|
-
<div class="section-method">
|
|
4714
4635
|
|
|
4715
4636
|
|
|
4716
4637
|
|
|
@@ -4720,20 +4641,20 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4720
4641
|
|
|
4721
4642
|
|
|
4722
4643
|
|
|
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
4644
|
|
|
4732
4645
|
<dl class="details">
|
|
4733
|
-
|
|
4646
|
+
|
|
4647
|
+
<dt class="tag-description">Description:</dt>
|
|
4648
|
+
<dd class="tag-description"><ul class="dummy"><li>Initializes the Sanity service with the given configuration.
|
|
4649
|
+
This function must be called before using any other functions in this library.</li></ul></dd>
|
|
4734
4650
|
|
|
4735
4651
|
|
|
4736
4652
|
|
|
4653
|
+
<dt class="tag-source">Source:</dt>
|
|
4654
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4655
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line25">line 25</a>
|
|
4656
|
+
</li></ul></dd>
|
|
4657
|
+
|
|
4737
4658
|
|
|
4738
4659
|
|
|
4739
4660
|
|
|
@@ -4756,10 +4677,7 @@ This function must be called before using any other functions in this library.
|
|
|
4756
4677
|
|
|
4757
4678
|
|
|
4758
4679
|
|
|
4759
|
-
|
|
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>
|
|
4680
|
+
|
|
4763
4681
|
|
|
4764
4682
|
|
|
4765
4683
|
|
|
@@ -4777,7 +4695,24 @@ This function must be called before using any other functions in this library.
|
|
|
4777
4695
|
|
|
4778
4696
|
|
|
4779
4697
|
|
|
4780
|
-
|
|
4698
|
+
|
|
4699
|
+
|
|
4700
|
+
<h5 class="h5-examples">Example</h5>
|
|
4701
|
+
|
|
4702
|
+
<pre class="prettyprint"><code>// Initialize the Sanity service in your app.js
|
|
4703
|
+
initializeSanityService({
|
|
4704
|
+
token: 'your-sanity-api-token',
|
|
4705
|
+
projectId: 'your-sanity-project-id',
|
|
4706
|
+
dataset: 'your-dataset-name',
|
|
4707
|
+
version: '2021-06-07',
|
|
4708
|
+
debug: true // Optional: Enable debug mode
|
|
4709
|
+
useCachedAPI: true // Optional: Use cached API
|
|
4710
|
+
});</code></pre>
|
|
4711
|
+
|
|
4712
|
+
|
|
4713
|
+
|
|
4714
|
+
|
|
4715
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4781
4716
|
|
|
4782
4717
|
|
|
4783
4718
|
<table class="params">
|
|
@@ -4808,7 +4743,8 @@ This function must be called before using any other functions in this library.
|
|
|
4808
4743
|
<td class="type">
|
|
4809
4744
|
|
|
4810
4745
|
|
|
4811
|
-
<span class="param-type"
|
|
4746
|
+
<span class="param-type">Object</span>
|
|
4747
|
+
|
|
4812
4748
|
|
|
4813
4749
|
|
|
4814
4750
|
|
|
@@ -4818,10 +4754,9 @@ This function must be called before using any other functions in this library.
|
|
|
4818
4754
|
|
|
4819
4755
|
|
|
4820
4756
|
|
|
4821
|
-
<td class="description last">
|
|
4822
|
-
|
|
4757
|
+
<td class="description last">Configuration object containing Sanity API settings.
|
|
4758
|
+
<h6>Properties</h6>
|
|
4823
4759
|
|
|
4824
|
-
|
|
4825
4760
|
|
|
4826
4761
|
<table class="params">
|
|
4827
4762
|
<thead>
|
|
@@ -4855,7 +4790,8 @@ This function must be called before using any other functions in this library.
|
|
|
4855
4790
|
<td class="type">
|
|
4856
4791
|
|
|
4857
4792
|
|
|
4858
|
-
<span class="param-type"
|
|
4793
|
+
<span class="param-type">string</span>
|
|
4794
|
+
|
|
4859
4795
|
|
|
4860
4796
|
|
|
4861
4797
|
|
|
@@ -4877,10 +4813,7 @@ This function must be called before using any other functions in this library.
|
|
|
4877
4813
|
</td>
|
|
4878
4814
|
|
|
4879
4815
|
|
|
4880
|
-
<td class="description last">
|
|
4881
|
-
The API token for authenticating with Sanity.
|
|
4882
|
-
|
|
4883
|
-
</td>
|
|
4816
|
+
<td class="description last">The API token for authenticating with Sanity.</td>
|
|
4884
4817
|
</tr>
|
|
4885
4818
|
|
|
4886
4819
|
|
|
@@ -4893,7 +4826,8 @@ This function must be called before using any other functions in this library.
|
|
|
4893
4826
|
<td class="type">
|
|
4894
4827
|
|
|
4895
4828
|
|
|
4896
|
-
<span class="param-type"
|
|
4829
|
+
<span class="param-type">string</span>
|
|
4830
|
+
|
|
4897
4831
|
|
|
4898
4832
|
|
|
4899
4833
|
|
|
@@ -4915,10 +4849,7 @@ This function must be called before using any other functions in this library.
|
|
|
4915
4849
|
</td>
|
|
4916
4850
|
|
|
4917
4851
|
|
|
4918
|
-
<td class="description last">
|
|
4919
|
-
The project ID in Sanity.
|
|
4920
|
-
|
|
4921
|
-
</td>
|
|
4852
|
+
<td class="description last">The project ID in Sanity.</td>
|
|
4922
4853
|
</tr>
|
|
4923
4854
|
|
|
4924
4855
|
|
|
@@ -4931,7 +4862,8 @@ This function must be called before using any other functions in this library.
|
|
|
4931
4862
|
<td class="type">
|
|
4932
4863
|
|
|
4933
4864
|
|
|
4934
|
-
<span class="param-type"
|
|
4865
|
+
<span class="param-type">string</span>
|
|
4866
|
+
|
|
4935
4867
|
|
|
4936
4868
|
|
|
4937
4869
|
|
|
@@ -4953,10 +4885,7 @@ This function must be called before using any other functions in this library.
|
|
|
4953
4885
|
</td>
|
|
4954
4886
|
|
|
4955
4887
|
|
|
4956
|
-
<td class="description last">
|
|
4957
|
-
The dataset name in Sanity.
|
|
4958
|
-
|
|
4959
|
-
</td>
|
|
4888
|
+
<td class="description last">The dataset name in Sanity.</td>
|
|
4960
4889
|
</tr>
|
|
4961
4890
|
|
|
4962
4891
|
|
|
@@ -4969,7 +4898,8 @@ This function must be called before using any other functions in this library.
|
|
|
4969
4898
|
<td class="type">
|
|
4970
4899
|
|
|
4971
4900
|
|
|
4972
|
-
<span class="param-type"
|
|
4901
|
+
<span class="param-type">string</span>
|
|
4902
|
+
|
|
4973
4903
|
|
|
4974
4904
|
|
|
4975
4905
|
|
|
@@ -4991,10 +4921,7 @@ This function must be called before using any other functions in this library.
|
|
|
4991
4921
|
</td>
|
|
4992
4922
|
|
|
4993
4923
|
|
|
4994
|
-
<td class="description last">
|
|
4995
|
-
The API version to use.
|
|
4996
|
-
|
|
4997
|
-
</td>
|
|
4924
|
+
<td class="description last">The API version to use.</td>
|
|
4998
4925
|
</tr>
|
|
4999
4926
|
|
|
5000
4927
|
|
|
@@ -5007,7 +4934,8 @@ This function must be called before using any other functions in this library.
|
|
|
5007
4934
|
<td class="type">
|
|
5008
4935
|
|
|
5009
4936
|
|
|
5010
|
-
<span class="param-type"
|
|
4937
|
+
<span class="param-type">boolean</span>
|
|
4938
|
+
|
|
5011
4939
|
|
|
5012
4940
|
|
|
5013
4941
|
|
|
@@ -5028,15 +4956,12 @@ This function must be called before using any other functions in this library.
|
|
|
5028
4956
|
|
|
5029
4957
|
<td class="default">
|
|
5030
4958
|
|
|
5031
|
-
false
|
|
4959
|
+
<code>false</code>
|
|
5032
4960
|
|
|
5033
4961
|
</td>
|
|
5034
4962
|
|
|
5035
4963
|
|
|
5036
|
-
<td class="description last">
|
|
5037
|
-
Optional flag to enable debug mode, which logs the query and results.
|
|
5038
|
-
|
|
5039
|
-
</td>
|
|
4964
|
+
<td class="description last">Optional flag to enable debug mode, which logs the query and results.</td>
|
|
5040
4965
|
</tr>
|
|
5041
4966
|
|
|
5042
4967
|
|
|
@@ -5049,7 +4974,8 @@ This function must be called before using any other functions in this library.
|
|
|
5049
4974
|
<td class="type">
|
|
5050
4975
|
|
|
5051
4976
|
|
|
5052
|
-
<span class="param-type"
|
|
4977
|
+
<span class="param-type">boolean</span>
|
|
4978
|
+
|
|
5053
4979
|
|
|
5054
4980
|
|
|
5055
4981
|
|
|
@@ -5070,22 +4996,18 @@ This function must be called before using any other functions in this library.
|
|
|
5070
4996
|
|
|
5071
4997
|
<td class="default">
|
|
5072
4998
|
|
|
5073
|
-
true
|
|
4999
|
+
<code>true</code>
|
|
5074
5000
|
|
|
5075
5001
|
</td>
|
|
5076
5002
|
|
|
5077
5003
|
|
|
5078
|
-
<td class="description last">
|
|
5079
|
-
Optional flag to disable cached API. *
|
|
5080
|
-
|
|
5081
|
-
</td>
|
|
5004
|
+
<td class="description last">Optional flag to disable cached API. *</td>
|
|
5082
5005
|
</tr>
|
|
5083
5006
|
|
|
5084
5007
|
|
|
5085
5008
|
</tbody>
|
|
5086
5009
|
</table>
|
|
5087
5010
|
|
|
5088
|
-
|
|
5089
5011
|
</td>
|
|
5090
5012
|
</tr>
|
|
5091
5013
|
|
|
@@ -5108,22 +5030,9 @@ This function must be called before using any other functions in this library.
|
|
|
5108
5030
|
|
|
5109
5031
|
|
|
5110
5032
|
|
|
5111
|
-
<div class="section-examples">
|
|
5112
|
-
<h5>Example</h5>
|
|
5113
5033
|
|
|
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
5034
|
|
|
5124
|
-
</div>
|
|
5125
5035
|
|
|
5126
|
-
</div>
|
|
5127
5036
|
|
|
5128
5037
|
|
|
5129
5038
|
|
|
@@ -5137,15 +5046,21 @@ initializeSanityService({
|
|
|
5137
5046
|
|
|
5138
5047
|
|
|
5139
5048
|
|
|
5049
|
+
|
|
5050
|
+
|
|
5140
5051
|
</div>
|
|
5141
5052
|
|
|
5142
5053
|
<br class="clear">
|
|
5143
5054
|
|
|
5144
5055
|
<footer>
|
|
5145
|
-
|
|
5056
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 12 2024 14:00:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
5146
5057
|
</footer>
|
|
5147
5058
|
|
|
5148
5059
|
<script>prettyPrint();</script>
|
|
5060
|
+
<script src="scripts/polyfill.js"></script>
|
|
5149
5061
|
<script src="scripts/linenumber.js"></script>
|
|
5062
|
+
|
|
5063
|
+
|
|
5064
|
+
|
|
5150
5065
|
</body>
|
|
5151
5066
|
</html>
|