@mustafaj/capacitor-plugin-playlist 0.9.7 → 0.9.8
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/README.md +4 -4
- package/android/build.gradle +15 -5
- package/android/gradlew +0 -0
- package/android/src/main/java/org/dwbn/plugins/playlist/PlaylistPlugin.kt +13 -12
- package/android/src/main/java/org/dwbn/plugins/playlist/data/AudioTrack.kt +14 -1
- package/android/src/main/java/org/dwbn/plugins/playlist/manager/PlaylistManager.kt +43 -12
- package/dist/docs.json +64 -901
- package/dist/esm/RmxAudioPlayer.js +2 -1
- package/dist/esm/RmxAudioPlayer.js.map +1 -1
- package/dist/esm/plugin.d.ts +1 -2
- package/dist/esm/plugin.js +30 -2
- package/dist/esm/plugin.js.map +1 -1
- package/dist/esm/utils.js +3 -0
- package/dist/esm/utils.js.map +1 -1
- package/dist/esm/web.d.ts +16 -0
- package/dist/esm/web.js +90 -47
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.js +134 -59
- package/dist/plugin.js.map +1 -1
- package/ios/Plugin/Plugin.swift +10 -7
- package/ios/Plugin/RmxAudioPlayer.swift +37 -10
- package/package.json +17 -19
package/dist/docs.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
"methods": [
|
|
8
8
|
{
|
|
9
9
|
"name": "addListener",
|
|
10
|
-
"signature": "(eventName: 'status', listenerFunc: PlaylistStatusChangeCallback) =>
|
|
10
|
+
"signature": "(eventName: 'status', listenerFunc: PlaylistStatusChangeCallback) => any",
|
|
11
11
|
"parameters": [
|
|
12
12
|
{
|
|
13
13
|
"name": "eventName",
|
|
@@ -20,18 +20,18 @@
|
|
|
20
20
|
"type": "PlaylistStatusChangeCallback"
|
|
21
21
|
}
|
|
22
22
|
],
|
|
23
|
-
"returns": "
|
|
23
|
+
"returns": "any",
|
|
24
24
|
"tags": [],
|
|
25
25
|
"docs": "Listen for screen reader state change (on/off)",
|
|
26
26
|
"complexTypes": [
|
|
27
|
-
"
|
|
28
|
-
"
|
|
27
|
+
"PlaylistStatusChangeCallback",
|
|
28
|
+
"PluginListenerHandle"
|
|
29
29
|
],
|
|
30
30
|
"slug": "addlistenerstatus-"
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
33
|
"name": "setOptions",
|
|
34
|
-
"signature": "(options: AudioPlayerOptions) =>
|
|
34
|
+
"signature": "(options: AudioPlayerOptions) => any",
|
|
35
35
|
"parameters": [
|
|
36
36
|
{
|
|
37
37
|
"name": "options",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"type": "AudioPlayerOptions"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
|
-
"returns": "
|
|
42
|
+
"returns": "any",
|
|
43
43
|
"tags": [],
|
|
44
44
|
"docs": "",
|
|
45
45
|
"complexTypes": [
|
|
@@ -49,9 +49,9 @@
|
|
|
49
49
|
},
|
|
50
50
|
{
|
|
51
51
|
"name": "initialize",
|
|
52
|
-
"signature": "() =>
|
|
52
|
+
"signature": "() => any",
|
|
53
53
|
"parameters": [],
|
|
54
|
-
"returns": "
|
|
54
|
+
"returns": "any",
|
|
55
55
|
"tags": [],
|
|
56
56
|
"docs": "",
|
|
57
57
|
"complexTypes": [],
|
|
@@ -59,9 +59,9 @@
|
|
|
59
59
|
},
|
|
60
60
|
{
|
|
61
61
|
"name": "release",
|
|
62
|
-
"signature": "() =>
|
|
62
|
+
"signature": "() => any",
|
|
63
63
|
"parameters": [],
|
|
64
|
-
"returns": "
|
|
64
|
+
"returns": "any",
|
|
65
65
|
"tags": [],
|
|
66
66
|
"docs": "",
|
|
67
67
|
"complexTypes": [],
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
},
|
|
70
70
|
{
|
|
71
71
|
"name": "setPlaylistItems",
|
|
72
|
-
"signature": "(options: PlaylistOptions) =>
|
|
72
|
+
"signature": "(options: PlaylistOptions) => any",
|
|
73
73
|
"parameters": [
|
|
74
74
|
{
|
|
75
75
|
"name": "options",
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
"type": "PlaylistOptions"
|
|
78
78
|
}
|
|
79
79
|
],
|
|
80
|
-
"returns": "
|
|
80
|
+
"returns": "any",
|
|
81
81
|
"tags": [],
|
|
82
82
|
"docs": "",
|
|
83
83
|
"complexTypes": [
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
},
|
|
88
88
|
{
|
|
89
89
|
"name": "addItem",
|
|
90
|
-
"signature": "(options: AddItemOptions) =>
|
|
90
|
+
"signature": "(options: AddItemOptions) => any",
|
|
91
91
|
"parameters": [
|
|
92
92
|
{
|
|
93
93
|
"name": "options",
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
"type": "AddItemOptions"
|
|
96
96
|
}
|
|
97
97
|
],
|
|
98
|
-
"returns": "
|
|
98
|
+
"returns": "any",
|
|
99
99
|
"tags": [],
|
|
100
100
|
"docs": "",
|
|
101
101
|
"complexTypes": [
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
},
|
|
106
106
|
{
|
|
107
107
|
"name": "addAllItems",
|
|
108
|
-
"signature": "(options: AddAllItemOptions) =>
|
|
108
|
+
"signature": "(options: AddAllItemOptions) => any",
|
|
109
109
|
"parameters": [
|
|
110
110
|
{
|
|
111
111
|
"name": "options",
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
"type": "AddAllItemOptions"
|
|
114
114
|
}
|
|
115
115
|
],
|
|
116
|
-
"returns": "
|
|
116
|
+
"returns": "any",
|
|
117
117
|
"tags": [],
|
|
118
118
|
"docs": "",
|
|
119
119
|
"complexTypes": [
|
|
@@ -123,7 +123,7 @@
|
|
|
123
123
|
},
|
|
124
124
|
{
|
|
125
125
|
"name": "removeItem",
|
|
126
|
-
"signature": "(options: RemoveItemOptions) =>
|
|
126
|
+
"signature": "(options: RemoveItemOptions) => any",
|
|
127
127
|
"parameters": [
|
|
128
128
|
{
|
|
129
129
|
"name": "options",
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
"type": "RemoveItemOptions"
|
|
132
132
|
}
|
|
133
133
|
],
|
|
134
|
-
"returns": "
|
|
134
|
+
"returns": "any",
|
|
135
135
|
"tags": [],
|
|
136
136
|
"docs": "",
|
|
137
137
|
"complexTypes": [
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
},
|
|
142
142
|
{
|
|
143
143
|
"name": "removeItems",
|
|
144
|
-
"signature": "(options: RemoveItemsOptions) =>
|
|
144
|
+
"signature": "(options: RemoveItemsOptions) => any",
|
|
145
145
|
"parameters": [
|
|
146
146
|
{
|
|
147
147
|
"name": "options",
|
|
@@ -149,7 +149,7 @@
|
|
|
149
149
|
"type": "RemoveItemsOptions"
|
|
150
150
|
}
|
|
151
151
|
],
|
|
152
|
-
"returns": "
|
|
152
|
+
"returns": "any",
|
|
153
153
|
"tags": [],
|
|
154
154
|
"docs": "",
|
|
155
155
|
"complexTypes": [
|
|
@@ -159,9 +159,9 @@
|
|
|
159
159
|
},
|
|
160
160
|
{
|
|
161
161
|
"name": "clearAllItems",
|
|
162
|
-
"signature": "() =>
|
|
162
|
+
"signature": "() => any",
|
|
163
163
|
"parameters": [],
|
|
164
|
-
"returns": "
|
|
164
|
+
"returns": "any",
|
|
165
165
|
"tags": [],
|
|
166
166
|
"docs": "",
|
|
167
167
|
"complexTypes": [],
|
|
@@ -169,9 +169,9 @@
|
|
|
169
169
|
},
|
|
170
170
|
{
|
|
171
171
|
"name": "getPlaylist",
|
|
172
|
-
"signature": "() =>
|
|
172
|
+
"signature": "() => any",
|
|
173
173
|
"parameters": [],
|
|
174
|
-
"returns": "
|
|
174
|
+
"returns": "any",
|
|
175
175
|
"tags": [],
|
|
176
176
|
"docs": "",
|
|
177
177
|
"complexTypes": [
|
|
@@ -181,9 +181,9 @@
|
|
|
181
181
|
},
|
|
182
182
|
{
|
|
183
183
|
"name": "play",
|
|
184
|
-
"signature": "() =>
|
|
184
|
+
"signature": "() => any",
|
|
185
185
|
"parameters": [],
|
|
186
|
-
"returns": "
|
|
186
|
+
"returns": "any",
|
|
187
187
|
"tags": [],
|
|
188
188
|
"docs": "",
|
|
189
189
|
"complexTypes": [],
|
|
@@ -191,9 +191,9 @@
|
|
|
191
191
|
},
|
|
192
192
|
{
|
|
193
193
|
"name": "pause",
|
|
194
|
-
"signature": "() =>
|
|
194
|
+
"signature": "() => any",
|
|
195
195
|
"parameters": [],
|
|
196
|
-
"returns": "
|
|
196
|
+
"returns": "any",
|
|
197
197
|
"tags": [],
|
|
198
198
|
"docs": "",
|
|
199
199
|
"complexTypes": [],
|
|
@@ -201,9 +201,9 @@
|
|
|
201
201
|
},
|
|
202
202
|
{
|
|
203
203
|
"name": "skipForward",
|
|
204
|
-
"signature": "() =>
|
|
204
|
+
"signature": "() => any",
|
|
205
205
|
"parameters": [],
|
|
206
|
-
"returns": "
|
|
206
|
+
"returns": "any",
|
|
207
207
|
"tags": [],
|
|
208
208
|
"docs": "",
|
|
209
209
|
"complexTypes": [],
|
|
@@ -211,9 +211,9 @@
|
|
|
211
211
|
},
|
|
212
212
|
{
|
|
213
213
|
"name": "skipBack",
|
|
214
|
-
"signature": "() =>
|
|
214
|
+
"signature": "() => any",
|
|
215
215
|
"parameters": [],
|
|
216
|
-
"returns": "
|
|
216
|
+
"returns": "any",
|
|
217
217
|
"tags": [],
|
|
218
218
|
"docs": "",
|
|
219
219
|
"complexTypes": [],
|
|
@@ -221,7 +221,7 @@
|
|
|
221
221
|
},
|
|
222
222
|
{
|
|
223
223
|
"name": "seekTo",
|
|
224
|
-
"signature": "(options: SeekToOptions) =>
|
|
224
|
+
"signature": "(options: SeekToOptions) => any",
|
|
225
225
|
"parameters": [
|
|
226
226
|
{
|
|
227
227
|
"name": "options",
|
|
@@ -229,7 +229,7 @@
|
|
|
229
229
|
"type": "SeekToOptions"
|
|
230
230
|
}
|
|
231
231
|
],
|
|
232
|
-
"returns": "
|
|
232
|
+
"returns": "any",
|
|
233
233
|
"tags": [],
|
|
234
234
|
"docs": "",
|
|
235
235
|
"complexTypes": [
|
|
@@ -239,7 +239,7 @@
|
|
|
239
239
|
},
|
|
240
240
|
{
|
|
241
241
|
"name": "playTrackByIndex",
|
|
242
|
-
"signature": "(options: PlayByIndexOptions) =>
|
|
242
|
+
"signature": "(options: PlayByIndexOptions) => any",
|
|
243
243
|
"parameters": [
|
|
244
244
|
{
|
|
245
245
|
"name": "options",
|
|
@@ -247,7 +247,7 @@
|
|
|
247
247
|
"type": "PlayByIndexOptions"
|
|
248
248
|
}
|
|
249
249
|
],
|
|
250
|
-
"returns": "
|
|
250
|
+
"returns": "any",
|
|
251
251
|
"tags": [],
|
|
252
252
|
"docs": "",
|
|
253
253
|
"complexTypes": [
|
|
@@ -257,7 +257,7 @@
|
|
|
257
257
|
},
|
|
258
258
|
{
|
|
259
259
|
"name": "playTrackById",
|
|
260
|
-
"signature": "(options: PlayByIdOptions) =>
|
|
260
|
+
"signature": "(options: PlayByIdOptions) => any",
|
|
261
261
|
"parameters": [
|
|
262
262
|
{
|
|
263
263
|
"name": "options",
|
|
@@ -265,7 +265,7 @@
|
|
|
265
265
|
"type": "PlayByIdOptions"
|
|
266
266
|
}
|
|
267
267
|
],
|
|
268
|
-
"returns": "
|
|
268
|
+
"returns": "any",
|
|
269
269
|
"tags": [],
|
|
270
270
|
"docs": "",
|
|
271
271
|
"complexTypes": [
|
|
@@ -275,7 +275,7 @@
|
|
|
275
275
|
},
|
|
276
276
|
{
|
|
277
277
|
"name": "selectTrackByIndex",
|
|
278
|
-
"signature": "(options: SelectByIndexOptions) =>
|
|
278
|
+
"signature": "(options: SelectByIndexOptions) => any",
|
|
279
279
|
"parameters": [
|
|
280
280
|
{
|
|
281
281
|
"name": "options",
|
|
@@ -283,7 +283,7 @@
|
|
|
283
283
|
"type": "SelectByIndexOptions"
|
|
284
284
|
}
|
|
285
285
|
],
|
|
286
|
-
"returns": "
|
|
286
|
+
"returns": "any",
|
|
287
287
|
"tags": [],
|
|
288
288
|
"docs": "",
|
|
289
289
|
"complexTypes": [
|
|
@@ -293,7 +293,7 @@
|
|
|
293
293
|
},
|
|
294
294
|
{
|
|
295
295
|
"name": "selectTrackById",
|
|
296
|
-
"signature": "(options: SelectByIdOptions) =>
|
|
296
|
+
"signature": "(options: SelectByIdOptions) => any",
|
|
297
297
|
"parameters": [
|
|
298
298
|
{
|
|
299
299
|
"name": "options",
|
|
@@ -301,7 +301,7 @@
|
|
|
301
301
|
"type": "SelectByIdOptions"
|
|
302
302
|
}
|
|
303
303
|
],
|
|
304
|
-
"returns": "
|
|
304
|
+
"returns": "any",
|
|
305
305
|
"tags": [],
|
|
306
306
|
"docs": "",
|
|
307
307
|
"complexTypes": [
|
|
@@ -311,7 +311,7 @@
|
|
|
311
311
|
},
|
|
312
312
|
{
|
|
313
313
|
"name": "setPlaybackVolume",
|
|
314
|
-
"signature": "(options: SetPlaybackVolumeOptions) =>
|
|
314
|
+
"signature": "(options: SetPlaybackVolumeOptions) => any",
|
|
315
315
|
"parameters": [
|
|
316
316
|
{
|
|
317
317
|
"name": "options",
|
|
@@ -319,7 +319,7 @@
|
|
|
319
319
|
"type": "SetPlaybackVolumeOptions"
|
|
320
320
|
}
|
|
321
321
|
],
|
|
322
|
-
"returns": "
|
|
322
|
+
"returns": "any",
|
|
323
323
|
"tags": [],
|
|
324
324
|
"docs": "",
|
|
325
325
|
"complexTypes": [
|
|
@@ -329,7 +329,7 @@
|
|
|
329
329
|
},
|
|
330
330
|
{
|
|
331
331
|
"name": "setLoop",
|
|
332
|
-
"signature": "(options: SetLoopOptions) =>
|
|
332
|
+
"signature": "(options: SetLoopOptions) => any",
|
|
333
333
|
"parameters": [
|
|
334
334
|
{
|
|
335
335
|
"name": "options",
|
|
@@ -337,7 +337,7 @@
|
|
|
337
337
|
"type": "SetLoopOptions"
|
|
338
338
|
}
|
|
339
339
|
],
|
|
340
|
-
"returns": "
|
|
340
|
+
"returns": "any",
|
|
341
341
|
"tags": [],
|
|
342
342
|
"docs": "",
|
|
343
343
|
"complexTypes": [
|
|
@@ -347,7 +347,7 @@
|
|
|
347
347
|
},
|
|
348
348
|
{
|
|
349
349
|
"name": "setPlaybackRate",
|
|
350
|
-
"signature": "(options: SetPlaybackRateOptions) =>
|
|
350
|
+
"signature": "(options: SetPlaybackRateOptions) => any",
|
|
351
351
|
"parameters": [
|
|
352
352
|
{
|
|
353
353
|
"name": "options",
|
|
@@ -355,7 +355,7 @@
|
|
|
355
355
|
"type": "SetPlaybackRateOptions"
|
|
356
356
|
}
|
|
357
357
|
],
|
|
358
|
-
"returns": "
|
|
358
|
+
"returns": "any",
|
|
359
359
|
"tags": [],
|
|
360
360
|
"docs": "",
|
|
361
361
|
"complexTypes": [
|
|
@@ -367,22 +367,6 @@
|
|
|
367
367
|
"properties": []
|
|
368
368
|
},
|
|
369
369
|
"interfaces": [
|
|
370
|
-
{
|
|
371
|
-
"name": "PluginListenerHandle",
|
|
372
|
-
"slug": "pluginlistenerhandle",
|
|
373
|
-
"docs": "",
|
|
374
|
-
"tags": [],
|
|
375
|
-
"methods": [],
|
|
376
|
-
"properties": [
|
|
377
|
-
{
|
|
378
|
-
"name": "remove",
|
|
379
|
-
"tags": [],
|
|
380
|
-
"docs": "",
|
|
381
|
-
"complexTypes": [],
|
|
382
|
-
"type": "() => Promise<void>"
|
|
383
|
-
}
|
|
384
|
-
]
|
|
385
|
-
},
|
|
386
370
|
{
|
|
387
371
|
"name": "PlaylistStatusChangeCallbackArg",
|
|
388
372
|
"slug": "playliststatuschangecallbackarg",
|
|
@@ -659,6 +643,22 @@
|
|
|
659
643
|
}
|
|
660
644
|
]
|
|
661
645
|
},
|
|
646
|
+
{
|
|
647
|
+
"name": "PluginListenerHandle",
|
|
648
|
+
"slug": "pluginlistenerhandle",
|
|
649
|
+
"docs": "",
|
|
650
|
+
"tags": [],
|
|
651
|
+
"methods": [],
|
|
652
|
+
"properties": [
|
|
653
|
+
{
|
|
654
|
+
"name": "remove",
|
|
655
|
+
"tags": [],
|
|
656
|
+
"docs": "",
|
|
657
|
+
"complexTypes": [],
|
|
658
|
+
"type": "() => any"
|
|
659
|
+
}
|
|
660
|
+
]
|
|
661
|
+
},
|
|
662
662
|
{
|
|
663
663
|
"name": "AudioPlayerOptions",
|
|
664
664
|
"slug": "audioplayeroptions",
|
|
@@ -735,843 +735,6 @@
|
|
|
735
735
|
}
|
|
736
736
|
]
|
|
737
737
|
},
|
|
738
|
-
{
|
|
739
|
-
"name": "Array",
|
|
740
|
-
"slug": "array",
|
|
741
|
-
"docs": "",
|
|
742
|
-
"tags": [],
|
|
743
|
-
"methods": [
|
|
744
|
-
{
|
|
745
|
-
"name": "toString",
|
|
746
|
-
"signature": "() => string",
|
|
747
|
-
"parameters": [],
|
|
748
|
-
"returns": "string",
|
|
749
|
-
"tags": [],
|
|
750
|
-
"docs": "Returns a string representation of an array.",
|
|
751
|
-
"complexTypes": [],
|
|
752
|
-
"slug": "tostring"
|
|
753
|
-
},
|
|
754
|
-
{
|
|
755
|
-
"name": "toLocaleString",
|
|
756
|
-
"signature": "() => string",
|
|
757
|
-
"parameters": [],
|
|
758
|
-
"returns": "string",
|
|
759
|
-
"tags": [],
|
|
760
|
-
"docs": "Returns a string representation of an array. The elements are converted to string using their toLocalString methods.",
|
|
761
|
-
"complexTypes": [],
|
|
762
|
-
"slug": "tolocalestring"
|
|
763
|
-
},
|
|
764
|
-
{
|
|
765
|
-
"name": "pop",
|
|
766
|
-
"signature": "() => T | undefined",
|
|
767
|
-
"parameters": [],
|
|
768
|
-
"returns": "T | undefined",
|
|
769
|
-
"tags": [],
|
|
770
|
-
"docs": "Removes the last element from an array and returns it.\r\nIf the array is empty, undefined is returned and the array is not modified.",
|
|
771
|
-
"complexTypes": [
|
|
772
|
-
"T"
|
|
773
|
-
],
|
|
774
|
-
"slug": "pop"
|
|
775
|
-
},
|
|
776
|
-
{
|
|
777
|
-
"name": "push",
|
|
778
|
-
"signature": "(...items: T[]) => number",
|
|
779
|
-
"parameters": [
|
|
780
|
-
{
|
|
781
|
-
"name": "items",
|
|
782
|
-
"docs": "New elements to add to the array.",
|
|
783
|
-
"type": "T[]"
|
|
784
|
-
}
|
|
785
|
-
],
|
|
786
|
-
"returns": "number",
|
|
787
|
-
"tags": [
|
|
788
|
-
{
|
|
789
|
-
"name": "param",
|
|
790
|
-
"text": "items New elements to add to the array."
|
|
791
|
-
}
|
|
792
|
-
],
|
|
793
|
-
"docs": "Appends new elements to the end of an array, and returns the new length of the array.",
|
|
794
|
-
"complexTypes": [
|
|
795
|
-
"T"
|
|
796
|
-
],
|
|
797
|
-
"slug": "push"
|
|
798
|
-
},
|
|
799
|
-
{
|
|
800
|
-
"name": "concat",
|
|
801
|
-
"signature": "(...items: ConcatArray<T>[]) => T[]",
|
|
802
|
-
"parameters": [
|
|
803
|
-
{
|
|
804
|
-
"name": "items",
|
|
805
|
-
"docs": "Additional arrays and/or items to add to the end of the array.",
|
|
806
|
-
"type": "ConcatArray<T>[]"
|
|
807
|
-
}
|
|
808
|
-
],
|
|
809
|
-
"returns": "T[]",
|
|
810
|
-
"tags": [
|
|
811
|
-
{
|
|
812
|
-
"name": "param",
|
|
813
|
-
"text": "items Additional arrays and/or items to add to the end of the array."
|
|
814
|
-
}
|
|
815
|
-
],
|
|
816
|
-
"docs": "Combines two or more arrays.\r\nThis method returns a new array without modifying any existing arrays.",
|
|
817
|
-
"complexTypes": [
|
|
818
|
-
"T",
|
|
819
|
-
"ConcatArray"
|
|
820
|
-
],
|
|
821
|
-
"slug": "concat"
|
|
822
|
-
},
|
|
823
|
-
{
|
|
824
|
-
"name": "concat",
|
|
825
|
-
"signature": "(...items: (T | ConcatArray<T>)[]) => T[]",
|
|
826
|
-
"parameters": [
|
|
827
|
-
{
|
|
828
|
-
"name": "items",
|
|
829
|
-
"docs": "Additional arrays and/or items to add to the end of the array.",
|
|
830
|
-
"type": "(T | ConcatArray<T>)[]"
|
|
831
|
-
}
|
|
832
|
-
],
|
|
833
|
-
"returns": "T[]",
|
|
834
|
-
"tags": [
|
|
835
|
-
{
|
|
836
|
-
"name": "param",
|
|
837
|
-
"text": "items Additional arrays and/or items to add to the end of the array."
|
|
838
|
-
}
|
|
839
|
-
],
|
|
840
|
-
"docs": "Combines two or more arrays.\r\nThis method returns a new array without modifying any existing arrays.",
|
|
841
|
-
"complexTypes": [
|
|
842
|
-
"T",
|
|
843
|
-
"ConcatArray"
|
|
844
|
-
],
|
|
845
|
-
"slug": "concat"
|
|
846
|
-
},
|
|
847
|
-
{
|
|
848
|
-
"name": "join",
|
|
849
|
-
"signature": "(separator?: string | undefined) => string",
|
|
850
|
-
"parameters": [
|
|
851
|
-
{
|
|
852
|
-
"name": "separator",
|
|
853
|
-
"docs": "A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.",
|
|
854
|
-
"type": "string | undefined"
|
|
855
|
-
}
|
|
856
|
-
],
|
|
857
|
-
"returns": "string",
|
|
858
|
-
"tags": [
|
|
859
|
-
{
|
|
860
|
-
"name": "param",
|
|
861
|
-
"text": "separator A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma."
|
|
862
|
-
}
|
|
863
|
-
],
|
|
864
|
-
"docs": "Adds all the elements of an array into a string, separated by the specified separator string.",
|
|
865
|
-
"complexTypes": [],
|
|
866
|
-
"slug": "join"
|
|
867
|
-
},
|
|
868
|
-
{
|
|
869
|
-
"name": "reverse",
|
|
870
|
-
"signature": "() => T[]",
|
|
871
|
-
"parameters": [],
|
|
872
|
-
"returns": "T[]",
|
|
873
|
-
"tags": [],
|
|
874
|
-
"docs": "Reverses the elements in an array in place.\r\nThis method mutates the array and returns a reference to the same array.",
|
|
875
|
-
"complexTypes": [
|
|
876
|
-
"T"
|
|
877
|
-
],
|
|
878
|
-
"slug": "reverse"
|
|
879
|
-
},
|
|
880
|
-
{
|
|
881
|
-
"name": "shift",
|
|
882
|
-
"signature": "() => T | undefined",
|
|
883
|
-
"parameters": [],
|
|
884
|
-
"returns": "T | undefined",
|
|
885
|
-
"tags": [],
|
|
886
|
-
"docs": "Removes the first element from an array and returns it.\r\nIf the array is empty, undefined is returned and the array is not modified.",
|
|
887
|
-
"complexTypes": [
|
|
888
|
-
"T"
|
|
889
|
-
],
|
|
890
|
-
"slug": "shift"
|
|
891
|
-
},
|
|
892
|
-
{
|
|
893
|
-
"name": "slice",
|
|
894
|
-
"signature": "(start?: number | undefined, end?: number | undefined) => T[]",
|
|
895
|
-
"parameters": [
|
|
896
|
-
{
|
|
897
|
-
"name": "start",
|
|
898
|
-
"docs": "The beginning index of the specified portion of the array.\r\nIf start is undefined, then the slice begins at index 0.",
|
|
899
|
-
"type": "number | undefined"
|
|
900
|
-
},
|
|
901
|
-
{
|
|
902
|
-
"name": "end",
|
|
903
|
-
"docs": "The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.\r\nIf end is undefined, then the slice extends to the end of the array.",
|
|
904
|
-
"type": "number | undefined"
|
|
905
|
-
}
|
|
906
|
-
],
|
|
907
|
-
"returns": "T[]",
|
|
908
|
-
"tags": [
|
|
909
|
-
{
|
|
910
|
-
"name": "param",
|
|
911
|
-
"text": "start The beginning index of the specified portion of the array.\r\nIf start is undefined, then the slice begins at index 0."
|
|
912
|
-
},
|
|
913
|
-
{
|
|
914
|
-
"name": "param",
|
|
915
|
-
"text": "end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.\r\nIf end is undefined, then the slice extends to the end of the array."
|
|
916
|
-
}
|
|
917
|
-
],
|
|
918
|
-
"docs": "Returns a copy of a section of an array.\r\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\r\nFor example, -2 refers to the second to last element of the array.",
|
|
919
|
-
"complexTypes": [
|
|
920
|
-
"T"
|
|
921
|
-
],
|
|
922
|
-
"slug": "slice"
|
|
923
|
-
},
|
|
924
|
-
{
|
|
925
|
-
"name": "sort",
|
|
926
|
-
"signature": "(compareFn?: ((a: T, b: T) => number) | undefined) => this",
|
|
927
|
-
"parameters": [
|
|
928
|
-
{
|
|
929
|
-
"name": "compareFn",
|
|
930
|
-
"docs": "Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```",
|
|
931
|
-
"type": "((a: T, b: T) => number) | undefined"
|
|
932
|
-
}
|
|
933
|
-
],
|
|
934
|
-
"returns": "this",
|
|
935
|
-
"tags": [
|
|
936
|
-
{
|
|
937
|
-
"name": "param",
|
|
938
|
-
"text": "compareFn Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```"
|
|
939
|
-
}
|
|
940
|
-
],
|
|
941
|
-
"docs": "Sorts an array in place.\r\nThis method mutates the array and returns a reference to the same array.",
|
|
942
|
-
"complexTypes": [
|
|
943
|
-
"T"
|
|
944
|
-
],
|
|
945
|
-
"slug": "sort"
|
|
946
|
-
},
|
|
947
|
-
{
|
|
948
|
-
"name": "splice",
|
|
949
|
-
"signature": "(start: number, deleteCount?: number | undefined) => T[]",
|
|
950
|
-
"parameters": [
|
|
951
|
-
{
|
|
952
|
-
"name": "start",
|
|
953
|
-
"docs": "The zero-based location in the array from which to start removing elements.",
|
|
954
|
-
"type": "number"
|
|
955
|
-
},
|
|
956
|
-
{
|
|
957
|
-
"name": "deleteCount",
|
|
958
|
-
"docs": "The number of elements to remove.",
|
|
959
|
-
"type": "number | undefined"
|
|
960
|
-
}
|
|
961
|
-
],
|
|
962
|
-
"returns": "T[]",
|
|
963
|
-
"tags": [
|
|
964
|
-
{
|
|
965
|
-
"name": "param",
|
|
966
|
-
"text": "start The zero-based location in the array from which to start removing elements."
|
|
967
|
-
},
|
|
968
|
-
{
|
|
969
|
-
"name": "param",
|
|
970
|
-
"text": "deleteCount The number of elements to remove."
|
|
971
|
-
},
|
|
972
|
-
{
|
|
973
|
-
"name": "returns",
|
|
974
|
-
"text": "An array containing the elements that were deleted."
|
|
975
|
-
}
|
|
976
|
-
],
|
|
977
|
-
"docs": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.",
|
|
978
|
-
"complexTypes": [
|
|
979
|
-
"T"
|
|
980
|
-
],
|
|
981
|
-
"slug": "splice"
|
|
982
|
-
},
|
|
983
|
-
{
|
|
984
|
-
"name": "splice",
|
|
985
|
-
"signature": "(start: number, deleteCount: number, ...items: T[]) => T[]",
|
|
986
|
-
"parameters": [
|
|
987
|
-
{
|
|
988
|
-
"name": "start",
|
|
989
|
-
"docs": "The zero-based location in the array from which to start removing elements.",
|
|
990
|
-
"type": "number"
|
|
991
|
-
},
|
|
992
|
-
{
|
|
993
|
-
"name": "deleteCount",
|
|
994
|
-
"docs": "The number of elements to remove.",
|
|
995
|
-
"type": "number"
|
|
996
|
-
},
|
|
997
|
-
{
|
|
998
|
-
"name": "items",
|
|
999
|
-
"docs": "Elements to insert into the array in place of the deleted elements.",
|
|
1000
|
-
"type": "T[]"
|
|
1001
|
-
}
|
|
1002
|
-
],
|
|
1003
|
-
"returns": "T[]",
|
|
1004
|
-
"tags": [
|
|
1005
|
-
{
|
|
1006
|
-
"name": "param",
|
|
1007
|
-
"text": "start The zero-based location in the array from which to start removing elements."
|
|
1008
|
-
},
|
|
1009
|
-
{
|
|
1010
|
-
"name": "param",
|
|
1011
|
-
"text": "deleteCount The number of elements to remove."
|
|
1012
|
-
},
|
|
1013
|
-
{
|
|
1014
|
-
"name": "param",
|
|
1015
|
-
"text": "items Elements to insert into the array in place of the deleted elements."
|
|
1016
|
-
},
|
|
1017
|
-
{
|
|
1018
|
-
"name": "returns",
|
|
1019
|
-
"text": "An array containing the elements that were deleted."
|
|
1020
|
-
}
|
|
1021
|
-
],
|
|
1022
|
-
"docs": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.",
|
|
1023
|
-
"complexTypes": [
|
|
1024
|
-
"T"
|
|
1025
|
-
],
|
|
1026
|
-
"slug": "splice"
|
|
1027
|
-
},
|
|
1028
|
-
{
|
|
1029
|
-
"name": "unshift",
|
|
1030
|
-
"signature": "(...items: T[]) => number",
|
|
1031
|
-
"parameters": [
|
|
1032
|
-
{
|
|
1033
|
-
"name": "items",
|
|
1034
|
-
"docs": "Elements to insert at the start of the array.",
|
|
1035
|
-
"type": "T[]"
|
|
1036
|
-
}
|
|
1037
|
-
],
|
|
1038
|
-
"returns": "number",
|
|
1039
|
-
"tags": [
|
|
1040
|
-
{
|
|
1041
|
-
"name": "param",
|
|
1042
|
-
"text": "items Elements to insert at the start of the array."
|
|
1043
|
-
}
|
|
1044
|
-
],
|
|
1045
|
-
"docs": "Inserts new elements at the start of an array, and returns the new length of the array.",
|
|
1046
|
-
"complexTypes": [
|
|
1047
|
-
"T"
|
|
1048
|
-
],
|
|
1049
|
-
"slug": "unshift"
|
|
1050
|
-
},
|
|
1051
|
-
{
|
|
1052
|
-
"name": "indexOf",
|
|
1053
|
-
"signature": "(searchElement: T, fromIndex?: number | undefined) => number",
|
|
1054
|
-
"parameters": [
|
|
1055
|
-
{
|
|
1056
|
-
"name": "searchElement",
|
|
1057
|
-
"docs": "The value to locate in the array.",
|
|
1058
|
-
"type": "T"
|
|
1059
|
-
},
|
|
1060
|
-
{
|
|
1061
|
-
"name": "fromIndex",
|
|
1062
|
-
"docs": "The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.",
|
|
1063
|
-
"type": "number | undefined"
|
|
1064
|
-
}
|
|
1065
|
-
],
|
|
1066
|
-
"returns": "number",
|
|
1067
|
-
"tags": [
|
|
1068
|
-
{
|
|
1069
|
-
"name": "param",
|
|
1070
|
-
"text": "searchElement The value to locate in the array."
|
|
1071
|
-
},
|
|
1072
|
-
{
|
|
1073
|
-
"name": "param",
|
|
1074
|
-
"text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0."
|
|
1075
|
-
}
|
|
1076
|
-
],
|
|
1077
|
-
"docs": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present.",
|
|
1078
|
-
"complexTypes": [
|
|
1079
|
-
"T"
|
|
1080
|
-
],
|
|
1081
|
-
"slug": "indexof"
|
|
1082
|
-
},
|
|
1083
|
-
{
|
|
1084
|
-
"name": "lastIndexOf",
|
|
1085
|
-
"signature": "(searchElement: T, fromIndex?: number | undefined) => number",
|
|
1086
|
-
"parameters": [
|
|
1087
|
-
{
|
|
1088
|
-
"name": "searchElement",
|
|
1089
|
-
"docs": "The value to locate in the array.",
|
|
1090
|
-
"type": "T"
|
|
1091
|
-
},
|
|
1092
|
-
{
|
|
1093
|
-
"name": "fromIndex",
|
|
1094
|
-
"docs": "The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.",
|
|
1095
|
-
"type": "number | undefined"
|
|
1096
|
-
}
|
|
1097
|
-
],
|
|
1098
|
-
"returns": "number",
|
|
1099
|
-
"tags": [
|
|
1100
|
-
{
|
|
1101
|
-
"name": "param",
|
|
1102
|
-
"text": "searchElement The value to locate in the array."
|
|
1103
|
-
},
|
|
1104
|
-
{
|
|
1105
|
-
"name": "param",
|
|
1106
|
-
"text": "fromIndex The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array."
|
|
1107
|
-
}
|
|
1108
|
-
],
|
|
1109
|
-
"docs": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.",
|
|
1110
|
-
"complexTypes": [
|
|
1111
|
-
"T"
|
|
1112
|
-
],
|
|
1113
|
-
"slug": "lastindexof"
|
|
1114
|
-
},
|
|
1115
|
-
{
|
|
1116
|
-
"name": "every",
|
|
1117
|
-
"signature": "<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]",
|
|
1118
|
-
"parameters": [
|
|
1119
|
-
{
|
|
1120
|
-
"name": "predicate",
|
|
1121
|
-
"docs": "A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array.",
|
|
1122
|
-
"type": "(value: T, index: number, array: T[]) => value is S"
|
|
1123
|
-
},
|
|
1124
|
-
{
|
|
1125
|
-
"name": "thisArg",
|
|
1126
|
-
"docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
|
|
1127
|
-
"type": "any"
|
|
1128
|
-
}
|
|
1129
|
-
],
|
|
1130
|
-
"returns": "boolean",
|
|
1131
|
-
"tags": [
|
|
1132
|
-
{
|
|
1133
|
-
"name": "param",
|
|
1134
|
-
"text": "predicate A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array."
|
|
1135
|
-
},
|
|
1136
|
-
{
|
|
1137
|
-
"name": "param",
|
|
1138
|
-
"text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
|
|
1139
|
-
}
|
|
1140
|
-
],
|
|
1141
|
-
"docs": "Determines whether all the members of an array satisfy the specified test.",
|
|
1142
|
-
"complexTypes": [
|
|
1143
|
-
"T",
|
|
1144
|
-
"S"
|
|
1145
|
-
],
|
|
1146
|
-
"slug": "every"
|
|
1147
|
-
},
|
|
1148
|
-
{
|
|
1149
|
-
"name": "every",
|
|
1150
|
-
"signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean",
|
|
1151
|
-
"parameters": [
|
|
1152
|
-
{
|
|
1153
|
-
"name": "predicate",
|
|
1154
|
-
"docs": "A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array.",
|
|
1155
|
-
"type": "(value: T, index: number, array: T[]) => unknown"
|
|
1156
|
-
},
|
|
1157
|
-
{
|
|
1158
|
-
"name": "thisArg",
|
|
1159
|
-
"docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
|
|
1160
|
-
"type": "any"
|
|
1161
|
-
}
|
|
1162
|
-
],
|
|
1163
|
-
"returns": "boolean",
|
|
1164
|
-
"tags": [
|
|
1165
|
-
{
|
|
1166
|
-
"name": "param",
|
|
1167
|
-
"text": "predicate A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array."
|
|
1168
|
-
},
|
|
1169
|
-
{
|
|
1170
|
-
"name": "param",
|
|
1171
|
-
"text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
|
|
1172
|
-
}
|
|
1173
|
-
],
|
|
1174
|
-
"docs": "Determines whether all the members of an array satisfy the specified test.",
|
|
1175
|
-
"complexTypes": [
|
|
1176
|
-
"T"
|
|
1177
|
-
],
|
|
1178
|
-
"slug": "every"
|
|
1179
|
-
},
|
|
1180
|
-
{
|
|
1181
|
-
"name": "some",
|
|
1182
|
-
"signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean",
|
|
1183
|
-
"parameters": [
|
|
1184
|
-
{
|
|
1185
|
-
"name": "predicate",
|
|
1186
|
-
"docs": "A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array.",
|
|
1187
|
-
"type": "(value: T, index: number, array: T[]) => unknown"
|
|
1188
|
-
},
|
|
1189
|
-
{
|
|
1190
|
-
"name": "thisArg",
|
|
1191
|
-
"docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
|
|
1192
|
-
"type": "any"
|
|
1193
|
-
}
|
|
1194
|
-
],
|
|
1195
|
-
"returns": "boolean",
|
|
1196
|
-
"tags": [
|
|
1197
|
-
{
|
|
1198
|
-
"name": "param",
|
|
1199
|
-
"text": "predicate A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array."
|
|
1200
|
-
},
|
|
1201
|
-
{
|
|
1202
|
-
"name": "param",
|
|
1203
|
-
"text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
|
|
1204
|
-
}
|
|
1205
|
-
],
|
|
1206
|
-
"docs": "Determines whether the specified callback function returns true for any element of an array.",
|
|
1207
|
-
"complexTypes": [
|
|
1208
|
-
"T"
|
|
1209
|
-
],
|
|
1210
|
-
"slug": "some"
|
|
1211
|
-
},
|
|
1212
|
-
{
|
|
1213
|
-
"name": "forEach",
|
|
1214
|
-
"signature": "(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void",
|
|
1215
|
-
"parameters": [
|
|
1216
|
-
{
|
|
1217
|
-
"name": "callbackfn",
|
|
1218
|
-
"docs": "A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.",
|
|
1219
|
-
"type": "(value: T, index: number, array: T[]) => void"
|
|
1220
|
-
},
|
|
1221
|
-
{
|
|
1222
|
-
"name": "thisArg",
|
|
1223
|
-
"docs": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.",
|
|
1224
|
-
"type": "any"
|
|
1225
|
-
}
|
|
1226
|
-
],
|
|
1227
|
-
"returns": "void",
|
|
1228
|
-
"tags": [
|
|
1229
|
-
{
|
|
1230
|
-
"name": "param",
|
|
1231
|
-
"text": "callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array."
|
|
1232
|
-
},
|
|
1233
|
-
{
|
|
1234
|
-
"name": "param",
|
|
1235
|
-
"text": "thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value."
|
|
1236
|
-
}
|
|
1237
|
-
],
|
|
1238
|
-
"docs": "Performs the specified action for each element in an array.",
|
|
1239
|
-
"complexTypes": [
|
|
1240
|
-
"T"
|
|
1241
|
-
],
|
|
1242
|
-
"slug": "foreach"
|
|
1243
|
-
},
|
|
1244
|
-
{
|
|
1245
|
-
"name": "map",
|
|
1246
|
-
"signature": "<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]",
|
|
1247
|
-
"parameters": [
|
|
1248
|
-
{
|
|
1249
|
-
"name": "callbackfn",
|
|
1250
|
-
"docs": "A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.",
|
|
1251
|
-
"type": "(value: T, index: number, array: T[]) => U"
|
|
1252
|
-
},
|
|
1253
|
-
{
|
|
1254
|
-
"name": "thisArg",
|
|
1255
|
-
"docs": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.",
|
|
1256
|
-
"type": "any"
|
|
1257
|
-
}
|
|
1258
|
-
],
|
|
1259
|
-
"returns": "U[]",
|
|
1260
|
-
"tags": [
|
|
1261
|
-
{
|
|
1262
|
-
"name": "param",
|
|
1263
|
-
"text": "callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array."
|
|
1264
|
-
},
|
|
1265
|
-
{
|
|
1266
|
-
"name": "param",
|
|
1267
|
-
"text": "thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value."
|
|
1268
|
-
}
|
|
1269
|
-
],
|
|
1270
|
-
"docs": "Calls a defined callback function on each element of an array, and returns an array that contains the results.",
|
|
1271
|
-
"complexTypes": [
|
|
1272
|
-
"U",
|
|
1273
|
-
"T"
|
|
1274
|
-
],
|
|
1275
|
-
"slug": "map"
|
|
1276
|
-
},
|
|
1277
|
-
{
|
|
1278
|
-
"name": "filter",
|
|
1279
|
-
"signature": "<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]",
|
|
1280
|
-
"parameters": [
|
|
1281
|
-
{
|
|
1282
|
-
"name": "predicate",
|
|
1283
|
-
"docs": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
|
|
1284
|
-
"type": "(value: T, index: number, array: T[]) => value is S"
|
|
1285
|
-
},
|
|
1286
|
-
{
|
|
1287
|
-
"name": "thisArg",
|
|
1288
|
-
"docs": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
|
|
1289
|
-
"type": "any"
|
|
1290
|
-
}
|
|
1291
|
-
],
|
|
1292
|
-
"returns": "S[]",
|
|
1293
|
-
"tags": [
|
|
1294
|
-
{
|
|
1295
|
-
"name": "param",
|
|
1296
|
-
"text": "predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array."
|
|
1297
|
-
},
|
|
1298
|
-
{
|
|
1299
|
-
"name": "param",
|
|
1300
|
-
"text": "thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value."
|
|
1301
|
-
}
|
|
1302
|
-
],
|
|
1303
|
-
"docs": "Returns the elements of an array that meet the condition specified in a callback function.",
|
|
1304
|
-
"complexTypes": [
|
|
1305
|
-
"S",
|
|
1306
|
-
"T"
|
|
1307
|
-
],
|
|
1308
|
-
"slug": "filter"
|
|
1309
|
-
},
|
|
1310
|
-
{
|
|
1311
|
-
"name": "filter",
|
|
1312
|
-
"signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]",
|
|
1313
|
-
"parameters": [
|
|
1314
|
-
{
|
|
1315
|
-
"name": "predicate",
|
|
1316
|
-
"docs": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
|
|
1317
|
-
"type": "(value: T, index: number, array: T[]) => unknown"
|
|
1318
|
-
},
|
|
1319
|
-
{
|
|
1320
|
-
"name": "thisArg",
|
|
1321
|
-
"docs": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
|
|
1322
|
-
"type": "any"
|
|
1323
|
-
}
|
|
1324
|
-
],
|
|
1325
|
-
"returns": "T[]",
|
|
1326
|
-
"tags": [
|
|
1327
|
-
{
|
|
1328
|
-
"name": "param",
|
|
1329
|
-
"text": "predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array."
|
|
1330
|
-
},
|
|
1331
|
-
{
|
|
1332
|
-
"name": "param",
|
|
1333
|
-
"text": "thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value."
|
|
1334
|
-
}
|
|
1335
|
-
],
|
|
1336
|
-
"docs": "Returns the elements of an array that meet the condition specified in a callback function.",
|
|
1337
|
-
"complexTypes": [
|
|
1338
|
-
"T"
|
|
1339
|
-
],
|
|
1340
|
-
"slug": "filter"
|
|
1341
|
-
},
|
|
1342
|
-
{
|
|
1343
|
-
"name": "reduce",
|
|
1344
|
-
"signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T",
|
|
1345
|
-
"parameters": [
|
|
1346
|
-
{
|
|
1347
|
-
"name": "callbackfn",
|
|
1348
|
-
"docs": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
|
|
1349
|
-
"type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
|
|
1350
|
-
}
|
|
1351
|
-
],
|
|
1352
|
-
"returns": "T",
|
|
1353
|
-
"tags": [
|
|
1354
|
-
{
|
|
1355
|
-
"name": "param",
|
|
1356
|
-
"text": "callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array."
|
|
1357
|
-
},
|
|
1358
|
-
{
|
|
1359
|
-
"name": "param",
|
|
1360
|
-
"text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
|
|
1361
|
-
}
|
|
1362
|
-
],
|
|
1363
|
-
"docs": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
|
|
1364
|
-
"complexTypes": [
|
|
1365
|
-
"T"
|
|
1366
|
-
],
|
|
1367
|
-
"slug": "reduce"
|
|
1368
|
-
},
|
|
1369
|
-
{
|
|
1370
|
-
"name": "reduce",
|
|
1371
|
-
"signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T",
|
|
1372
|
-
"parameters": [
|
|
1373
|
-
{
|
|
1374
|
-
"name": "callbackfn",
|
|
1375
|
-
"docs": "",
|
|
1376
|
-
"type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
|
|
1377
|
-
},
|
|
1378
|
-
{
|
|
1379
|
-
"name": "initialValue",
|
|
1380
|
-
"docs": "",
|
|
1381
|
-
"type": "T"
|
|
1382
|
-
}
|
|
1383
|
-
],
|
|
1384
|
-
"returns": "T",
|
|
1385
|
-
"tags": [],
|
|
1386
|
-
"docs": "",
|
|
1387
|
-
"complexTypes": [
|
|
1388
|
-
"T"
|
|
1389
|
-
],
|
|
1390
|
-
"slug": "reduce"
|
|
1391
|
-
},
|
|
1392
|
-
{
|
|
1393
|
-
"name": "reduce",
|
|
1394
|
-
"signature": "<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U",
|
|
1395
|
-
"parameters": [
|
|
1396
|
-
{
|
|
1397
|
-
"name": "callbackfn",
|
|
1398
|
-
"docs": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
|
|
1399
|
-
"type": "(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U"
|
|
1400
|
-
},
|
|
1401
|
-
{
|
|
1402
|
-
"name": "initialValue",
|
|
1403
|
-
"docs": "If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.",
|
|
1404
|
-
"type": "U"
|
|
1405
|
-
}
|
|
1406
|
-
],
|
|
1407
|
-
"returns": "U",
|
|
1408
|
-
"tags": [
|
|
1409
|
-
{
|
|
1410
|
-
"name": "param",
|
|
1411
|
-
"text": "callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array."
|
|
1412
|
-
},
|
|
1413
|
-
{
|
|
1414
|
-
"name": "param",
|
|
1415
|
-
"text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
|
|
1416
|
-
}
|
|
1417
|
-
],
|
|
1418
|
-
"docs": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
|
|
1419
|
-
"complexTypes": [
|
|
1420
|
-
"U",
|
|
1421
|
-
"T"
|
|
1422
|
-
],
|
|
1423
|
-
"slug": "reduce"
|
|
1424
|
-
},
|
|
1425
|
-
{
|
|
1426
|
-
"name": "reduceRight",
|
|
1427
|
-
"signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T",
|
|
1428
|
-
"parameters": [
|
|
1429
|
-
{
|
|
1430
|
-
"name": "callbackfn",
|
|
1431
|
-
"docs": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
|
|
1432
|
-
"type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
|
|
1433
|
-
}
|
|
1434
|
-
],
|
|
1435
|
-
"returns": "T",
|
|
1436
|
-
"tags": [
|
|
1437
|
-
{
|
|
1438
|
-
"name": "param",
|
|
1439
|
-
"text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array."
|
|
1440
|
-
},
|
|
1441
|
-
{
|
|
1442
|
-
"name": "param",
|
|
1443
|
-
"text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
|
|
1444
|
-
}
|
|
1445
|
-
],
|
|
1446
|
-
"docs": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
|
|
1447
|
-
"complexTypes": [
|
|
1448
|
-
"T"
|
|
1449
|
-
],
|
|
1450
|
-
"slug": "reduceright"
|
|
1451
|
-
},
|
|
1452
|
-
{
|
|
1453
|
-
"name": "reduceRight",
|
|
1454
|
-
"signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T",
|
|
1455
|
-
"parameters": [
|
|
1456
|
-
{
|
|
1457
|
-
"name": "callbackfn",
|
|
1458
|
-
"docs": "",
|
|
1459
|
-
"type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
|
|
1460
|
-
},
|
|
1461
|
-
{
|
|
1462
|
-
"name": "initialValue",
|
|
1463
|
-
"docs": "",
|
|
1464
|
-
"type": "T"
|
|
1465
|
-
}
|
|
1466
|
-
],
|
|
1467
|
-
"returns": "T",
|
|
1468
|
-
"tags": [],
|
|
1469
|
-
"docs": "",
|
|
1470
|
-
"complexTypes": [
|
|
1471
|
-
"T"
|
|
1472
|
-
],
|
|
1473
|
-
"slug": "reduceright"
|
|
1474
|
-
},
|
|
1475
|
-
{
|
|
1476
|
-
"name": "reduceRight",
|
|
1477
|
-
"signature": "<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U",
|
|
1478
|
-
"parameters": [
|
|
1479
|
-
{
|
|
1480
|
-
"name": "callbackfn",
|
|
1481
|
-
"docs": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
|
|
1482
|
-
"type": "(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U"
|
|
1483
|
-
},
|
|
1484
|
-
{
|
|
1485
|
-
"name": "initialValue",
|
|
1486
|
-
"docs": "If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.",
|
|
1487
|
-
"type": "U"
|
|
1488
|
-
}
|
|
1489
|
-
],
|
|
1490
|
-
"returns": "U",
|
|
1491
|
-
"tags": [
|
|
1492
|
-
{
|
|
1493
|
-
"name": "param",
|
|
1494
|
-
"text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array."
|
|
1495
|
-
},
|
|
1496
|
-
{
|
|
1497
|
-
"name": "param",
|
|
1498
|
-
"text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
|
|
1499
|
-
}
|
|
1500
|
-
],
|
|
1501
|
-
"docs": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
|
|
1502
|
-
"complexTypes": [
|
|
1503
|
-
"U",
|
|
1504
|
-
"T"
|
|
1505
|
-
],
|
|
1506
|
-
"slug": "reduceright"
|
|
1507
|
-
}
|
|
1508
|
-
],
|
|
1509
|
-
"properties": [
|
|
1510
|
-
{
|
|
1511
|
-
"name": "length",
|
|
1512
|
-
"tags": [],
|
|
1513
|
-
"docs": "Gets or sets the length of the array. This is a number one higher than the highest index in the array.",
|
|
1514
|
-
"complexTypes": [],
|
|
1515
|
-
"type": "number"
|
|
1516
|
-
}
|
|
1517
|
-
]
|
|
1518
|
-
},
|
|
1519
|
-
{
|
|
1520
|
-
"name": "ConcatArray",
|
|
1521
|
-
"slug": "concatarray",
|
|
1522
|
-
"docs": "",
|
|
1523
|
-
"tags": [],
|
|
1524
|
-
"methods": [
|
|
1525
|
-
{
|
|
1526
|
-
"name": "join",
|
|
1527
|
-
"signature": "(separator?: string | undefined) => string",
|
|
1528
|
-
"parameters": [
|
|
1529
|
-
{
|
|
1530
|
-
"name": "separator",
|
|
1531
|
-
"docs": "",
|
|
1532
|
-
"type": "string | undefined"
|
|
1533
|
-
}
|
|
1534
|
-
],
|
|
1535
|
-
"returns": "string",
|
|
1536
|
-
"tags": [],
|
|
1537
|
-
"docs": "",
|
|
1538
|
-
"complexTypes": [],
|
|
1539
|
-
"slug": "join"
|
|
1540
|
-
},
|
|
1541
|
-
{
|
|
1542
|
-
"name": "slice",
|
|
1543
|
-
"signature": "(start?: number | undefined, end?: number | undefined) => T[]",
|
|
1544
|
-
"parameters": [
|
|
1545
|
-
{
|
|
1546
|
-
"name": "start",
|
|
1547
|
-
"docs": "",
|
|
1548
|
-
"type": "number | undefined"
|
|
1549
|
-
},
|
|
1550
|
-
{
|
|
1551
|
-
"name": "end",
|
|
1552
|
-
"docs": "",
|
|
1553
|
-
"type": "number | undefined"
|
|
1554
|
-
}
|
|
1555
|
-
],
|
|
1556
|
-
"returns": "T[]",
|
|
1557
|
-
"tags": [],
|
|
1558
|
-
"docs": "",
|
|
1559
|
-
"complexTypes": [
|
|
1560
|
-
"T"
|
|
1561
|
-
],
|
|
1562
|
-
"slug": "slice"
|
|
1563
|
-
}
|
|
1564
|
-
],
|
|
1565
|
-
"properties": [
|
|
1566
|
-
{
|
|
1567
|
-
"name": "length",
|
|
1568
|
-
"tags": [],
|
|
1569
|
-
"docs": "",
|
|
1570
|
-
"complexTypes": [],
|
|
1571
|
-
"type": "number"
|
|
1572
|
-
}
|
|
1573
|
-
]
|
|
1574
|
-
},
|
|
1575
738
|
{
|
|
1576
739
|
"name": "PlaylistItemOptions",
|
|
1577
740
|
"slug": "playlistitemoptions",
|