@mkody/twitch-emoticons 2.5.0 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.github/codeql/codeql-config.yml +5 -0
  2. package/.github/workflows/codeql.yml +50 -0
  3. package/.github/workflows/eslint.yml +51 -0
  4. package/.github/workflows/yarn-test.yml +0 -1
  5. package/.jsdoc.json +5 -0
  6. package/LICENSE +1 -0
  7. package/README.md +85 -13
  8. package/docs/BTTVEmote.html +1241 -1191
  9. package/docs/Channel.html +823 -700
  10. package/docs/Collection.html +797 -791
  11. package/docs/Emote.html +801 -768
  12. package/docs/EmoteFetcher.html +2694 -2075
  13. package/docs/EmoteParser.html +811 -792
  14. package/docs/FFZEmote.html +1317 -1263
  15. package/docs/SevenTV.html +1191 -0
  16. package/docs/SevenTVEmote.html +1318 -0
  17. package/docs/TwitchEmote.html +1237 -1189
  18. package/docs/index.html +201 -132
  19. package/docs/scripts/collapse.js +38 -19
  20. package/docs/scripts/commonNav.js +28 -0
  21. package/docs/scripts/search.js +98 -82
  22. package/docs/struct_BTTVEmote.js.html +72 -69
  23. package/docs/struct_Channel.js.html +88 -77
  24. package/docs/struct_Emote.js.html +73 -70
  25. package/docs/struct_EmoteFetcher.js.html +168 -109
  26. package/docs/struct_EmoteParser.js.html +72 -69
  27. package/docs/struct_FFZEmote.js.html +72 -69
  28. package/docs/struct_SevenTVEmote.js.html +135 -0
  29. package/docs/struct_TwitchEmote.js.html +72 -69
  30. package/docs/styles/jsdoc.css +776 -765
  31. package/docs/styles/prettify.css +80 -79
  32. package/docs/util_Collection.js.html +72 -69
  33. package/package.json +15 -13
  34. package/src/index.js +4 -3
  35. package/src/struct/Channel.js +16 -8
  36. package/src/struct/Emote.js +1 -1
  37. package/src/struct/EmoteFetcher.js +96 -40
  38. package/src/struct/SevenTVEmote.js +63 -0
  39. package/src/util/Constants.js +5 -1
  40. package/test/index.js +39 -3
  41. package/typings/index.d.ts +35 -18
  42. package/typings/test.ts +0 -24
package/docs/Channel.html CHANGED
@@ -1,701 +1,824 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>Channel - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
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
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
- </head>
19
- <body>
20
-
21
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
22
- <label for="nav-trigger" class="navicon-button x">
23
- <div class="navicon"></div>
24
- </label>
25
-
26
- <label for="nav-trigger" class="overlay"></label>
27
-
28
- <nav >
29
-
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html#toLink">toLink</a></li><li data-type='method'><a href="BTTVEmote.html#toString">toString</a></li></ul></li><li><a href="Channel.html">Channel</a><ul class='methods'><li data-type='method'><a href="Channel.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="Channel.html#fetchFFZEmotes">fetchFFZEmotes</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toString">toString</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#toString">toString</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#toString">toString</a></li></ul></li></ul>
31
- </nav>
32
-
33
- <div id="main">
34
-
35
- <h1 class="page-title">Channel</h1>
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
- <section>
44
-
45
- <header>
46
-
47
- <h2>
48
- Channel
49
- </h2>
50
-
51
-
52
- </header>
53
-
54
- <article>
55
-
56
- <div class="container-overview">
57
-
58
-
59
-
60
-
61
-
62
- <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(fetcher, name)</span><span class="type-signature"></span></h4>
63
-
64
-
65
-
66
-
67
-
68
-
69
- <dl class="details">
70
-
71
-
72
- <dt class="tag-source">Source:</dt>
73
- <dd class="tag-source"><ul class="dummy"><li>
74
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line9">line 9</a>
75
- </li></ul></dd>
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
- </dl>
108
-
109
-
110
-
111
-
112
-
113
- <div class="description usertext">
114
- <p>A Twitch channel.</p>
115
- </div>
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
- <h5>Parameters:</h5>
128
-
129
-
130
- <table class="params">
131
- <thead>
132
- <tr>
133
-
134
- <th>Name</th>
135
-
136
-
137
- <th>Type</th>
138
-
139
-
140
-
141
-
142
-
143
- <th class="last">Description</th>
144
- </tr>
145
- </thead>
146
-
147
- <tbody>
148
-
149
-
150
- <tr>
151
-
152
- <td class="name"><code>fetcher</code></td>
153
-
154
-
155
- <td class="type">
156
-
157
-
158
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
159
-
160
-
161
-
162
- </td>
163
-
164
-
165
-
166
-
167
-
168
- <td class="description last"><p>The emote fetcher.</p></td>
169
- </tr>
170
-
171
-
172
-
173
- <tr>
174
-
175
- <td class="name"><code>name</code></td>
176
-
177
-
178
- <td class="type">
179
-
180
-
181
- <span class="param-type">string</span>
182
-
183
-
184
-
185
- </td>
186
-
187
-
188
-
189
-
190
-
191
- <td class="description last"><p>The name of the channel.</p></td>
192
- </tr>
193
-
194
-
195
- </tbody>
196
- </table>
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
- </div>
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <h3 class="subsection-title">Members</h3>
234
-
235
-
236
-
237
- <h4 class="name" id="emotes"><span class="type-signature"></span>emotes<span class="type-signature"> :<a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span></h4>
238
-
239
-
240
-
241
-
242
-
243
- <dl class="details">
244
-
245
-
246
- <dt class="tag-source">Source:</dt>
247
- <dd class="tag-source"><ul class="dummy"><li>
248
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line27">line 27</a>
249
- </li></ul></dd>
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
- </dl>
282
-
283
-
284
-
285
-
286
-
287
- <div class="description usertext">
288
- <p>Cached emotes belonging to this channel.</p>
289
- </div>
290
-
291
-
292
-
293
- <h5>Type:</h5>
294
- <ul>
295
- <li>
296
-
297
- <span class="param-type"><a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span>
298
-
299
-
300
- </li>
301
- </ul>
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
- <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
311
-
312
-
313
-
314
-
315
-
316
- <dl class="details">
317
-
318
-
319
- <dt class="tag-source">Source:</dt>
320
- <dd class="tag-source"><ul class="dummy"><li>
321
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line14">line 14</a>
322
- </li></ul></dd>
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
- </dl>
355
-
356
-
357
-
358
-
359
-
360
- <div class="description usertext">
361
- <p>The emote fetcher.</p>
362
- </div>
363
-
364
-
365
-
366
- <h5>Type:</h5>
367
- <ul>
368
- <li>
369
-
370
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
371
-
372
-
373
- </li>
374
- </ul>
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
- <h4 class="name" id="name"><span class="type-signature">(nullable) </span>name<span class="type-signature"> :string</span></h4>
384
-
385
-
386
-
387
-
388
-
389
- <dl class="details">
390
-
391
-
392
- <dt class="tag-source">Source:</dt>
393
- <dd class="tag-source"><ul class="dummy"><li>
394
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line21">line 21</a>
395
- </li></ul></dd>
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
- </dl>
428
-
429
-
430
-
431
-
432
-
433
- <div class="description usertext">
434
- <p>The name of this channel.<br>
435
- For the global channel, the name will be null.</p>
436
- </div>
437
-
438
-
439
-
440
- <h5>Type:</h5>
441
- <ul>
442
- <li>
443
-
444
- <span class="param-type">string</span>
445
-
446
-
447
- </li>
448
- </ul>
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
- <h3 class="subsection-title">Methods</h3>
460
-
461
-
462
-
463
-
464
-
465
-
466
- <h4 class="name" id="fetchBTTVEmotes"><span class="type-signature"></span>fetchBTTVEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="BTTVEmote.html">BTTVEmote</a>>>}</span></h4>
467
-
468
-
469
-
470
-
471
-
472
-
473
- <dl class="details">
474
-
475
-
476
- <dt class="tag-source">Source:</dt>
477
- <dd class="tag-source"><ul class="dummy"><li>
478
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line34">line 34</a>
479
- </li></ul></dd>
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
- </dl>
512
-
513
-
514
-
515
-
516
-
517
- <div class="description usertext">
518
- <p>Fetches the BTTV emotes for this channel.</p>
519
- </div>
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
- <h5>Returns:</h5>
546
-
547
-
548
-
549
-
550
- <dl class="param-type">
551
- <dt>
552
- Type
553
- </dt>
554
- <dd>
555
-
556
- <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="BTTVEmote.html">BTTVEmote</a>>></span>
557
-
558
-
559
- </dd>
560
- </dl>
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
- <h4 class="name" id="fetchFFZEmotes"><span class="type-signature"></span>fetchFFZEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>>}</span></h4>
572
-
573
-
574
-
575
-
576
-
577
-
578
- <dl class="details">
579
-
580
-
581
- <dt class="tag-source">Source:</dt>
582
- <dd class="tag-source"><ul class="dummy"><li>
583
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line42">line 42</a>
584
- </li></ul></dd>
585
-
586
-
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
- </dl>
617
-
618
-
619
-
620
-
621
-
622
- <div class="description usertext">
623
- <p>Fetches the FFZ emotes for this channel.</p>
624
- </div>
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
- <h5>Returns:</h5>
651
-
652
-
653
-
654
-
655
- <dl class="param-type">
656
- <dt>
657
- Type
658
- </dt>
659
- <dd>
660
-
661
- <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>></span>
662
-
663
-
664
- </dd>
665
- </dl>
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
- </article>
678
-
679
- </section>
680
-
681
-
682
-
683
-
684
-
685
-
686
- </div>
687
-
688
- <br class="clear">
689
-
690
- <footer>
691
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
692
- </footer>
693
-
694
- <script>prettyPrint();</script>
695
- <script src="scripts/polyfill.js"></script>
696
- <script src="scripts/linenumber.js"></script>
697
-
698
-
699
-
700
- </body>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>Channel - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
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">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="BTTVEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="Channel.html">Channel</a><ul class='methods'><li data-type='method'><a href="Channel.html#.fetchBTTVEmotes#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="Channel.html#.fetchFFZEmotes#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="Channel.html#.fetchSevenTVEmotes#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#.filter#filter">filter</a></li><li data-type='method'><a href="Collection.html#.find#find">find</a></li><li data-type='method'><a href="Collection.html#.map#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#.toString#toString">toString</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#._cacheBTTVEmote#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheFFZEmote#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheSevenTVEmote#_cacheSevenTVEmote">_cacheSevenTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheTwitchEmote#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawBTTVEmotes#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawFFZEmotes#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawSevenTVEmotes#_getRawSevenTVEmotes">_getRawSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawTwitchEmotes#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchBTTVEmotes#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchFFZEmotes#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchSevenTVEmotes#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchTwitchEmotes#fetchTwitchEmotes">fetchTwitchEmotes</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#.parse#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="SevenTVEmote.html">SevenTVEmote</a><ul class='methods'><li data-type='method'><a href="SevenTVEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="SevenTVEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#.toString#toString">toString</a></li></ul></li></ul>
33
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">Channel</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+ <h2>
51
+
52
+ Channel
53
+
54
+ </h2>
55
+
56
+
57
+ </header>
58
+
59
+ <article>
60
+
61
+ <div class="container-overview">
62
+
63
+
64
+
65
+
66
+
67
+ <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(fetcher, id)</span><span class="type-signature"></span></h4>
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dl class="details">
75
+
76
+ <dt class="tag-description">Description:</dt>
77
+ <dd class="tag-description"><ul class="dummy"><li><p>A Twitch channel.</p></li></ul></dd>
78
+
79
+
80
+
81
+ <dt class="tag-source">Source:</dt>
82
+ <dd class="tag-source"><ul class="dummy"><li>
83
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line9">line 9</a>
84
+ </li></ul></dd>
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+ </dl>
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <h5 class="h5-parameters">Parameters:</h5>
131
+
132
+
133
+ <table class="params">
134
+ <thead>
135
+ <tr>
136
+
137
+ <th>Name</th>
138
+
139
+
140
+ <th>Type</th>
141
+
142
+
143
+
144
+
145
+
146
+ <th class="last">Description</th>
147
+ </tr>
148
+ </thead>
149
+
150
+ <tbody>
151
+
152
+
153
+ <tr>
154
+
155
+ <td class="name"><code>fetcher</code></td>
156
+
157
+
158
+ <td class="type">
159
+
160
+
161
+ <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
162
+
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last"><p>The emote fetcher.</p></td>
173
+ </tr>
174
+
175
+
176
+
177
+ <tr>
178
+
179
+ <td class="name"><code>id</code></td>
180
+
181
+
182
+ <td class="type">
183
+
184
+
185
+ <span class="param-type">int</span>
186
+
187
+
188
+
189
+
190
+ </td>
191
+
192
+
193
+
194
+
195
+
196
+ <td class="description last"><p>ID of the channel.</p></td>
197
+ </tr>
198
+
199
+
200
+ </tbody>
201
+ </table>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ </div>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <h3 class="subsection-title">Members</h3>
239
+
240
+
241
+
242
+ <h4 class="name" id="channel_id"><span class="type-signature type-signature-nullable">(nullable) </span>channel_id<span class="type-signature"> :int</span></h4>
243
+
244
+
245
+
246
+
247
+
248
+ <dl class="details">
249
+
250
+ <dt class="tag-description">Description:</dt>
251
+ <dd class="tag-description"><ul class="dummy"><li><p>The ID of this channel.<br>
252
+ For the global channel, the ID will be null.</p></li></ul></dd>
253
+
254
+
255
+
256
+ <dt class="tag-source">Source:</dt>
257
+ <dd class="tag-source"><ul class="dummy"><li>
258
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line21">line 21</a>
259
+ </li></ul></dd>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ </dl>
292
+
293
+
294
+
295
+
296
+
297
+ <div class="description usertext">
298
+ <p>The ID of this channel.<br>
299
+ For the global channel, the ID will be null.</p>
300
+ </div>
301
+
302
+
303
+
304
+ <h5 class="h5-types">Type:</h5>
305
+ <ul>
306
+ <li>
307
+
308
+ <span class="param-type">int</span>
309
+
310
+
311
+
312
+ </li>
313
+ </ul>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+ <h4 class="name" id="emotes"><span class="type-signature"></span>emotes<span class="type-signature"> :<a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span></h4>
323
+
324
+
325
+
326
+
327
+
328
+ <dl class="details">
329
+
330
+ <dt class="tag-description">Description:</dt>
331
+ <dd class="tag-description"><ul class="dummy"><li><p>Cached emotes belonging to this channel.</p></li></ul></dd>
332
+
333
+
334
+
335
+ <dt class="tag-source">Source:</dt>
336
+ <dd class="tag-source"><ul class="dummy"><li>
337
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line27">line 27</a>
338
+ </li></ul></dd>
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ </dl>
371
+
372
+
373
+
374
+
375
+
376
+ <div class="description usertext">
377
+ <p>Cached emotes belonging to this channel.</p>
378
+ </div>
379
+
380
+
381
+
382
+ <h5 class="h5-types">Type:</h5>
383
+ <ul>
384
+ <li>
385
+
386
+ <span class="param-type"><a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span>
387
+
388
+
389
+
390
+ </li>
391
+ </ul>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+ <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
401
+
402
+
403
+
404
+
405
+
406
+ <dl class="details">
407
+
408
+ <dt class="tag-description">Description:</dt>
409
+ <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
410
+
411
+
412
+
413
+ <dt class="tag-source">Source:</dt>
414
+ <dd class="tag-source"><ul class="dummy"><li>
415
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line14">line 14</a>
416
+ </li></ul></dd>
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ </dl>
449
+
450
+
451
+
452
+
453
+
454
+ <div class="description usertext">
455
+ <p>The emote fetcher.</p>
456
+ </div>
457
+
458
+
459
+
460
+ <h5 class="h5-types">Type:</h5>
461
+ <ul>
462
+ <li>
463
+
464
+ <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
465
+
466
+
467
+
468
+ </li>
469
+ </ul>
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+ <h3 class="subsection-title">Methods</h3>
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <h4 class="name" id="fetchBTTVEmotes"><span class="type-signature"></span>fetchBTTVEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="BTTVEmote.html">BTTVEmote</a>>>}</span></h4>
488
+
489
+
490
+
491
+
492
+
493
+
494
+ <dl class="details">
495
+
496
+ <dt class="tag-description">Description:</dt>
497
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the BTTV emotes for this channel.</p></li></ul></dd>
498
+
499
+
500
+
501
+ <dt class="tag-source">Source:</dt>
502
+ <dd class="tag-source"><ul class="dummy"><li>
503
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line34">line 34</a>
504
+ </li></ul></dd>
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+ </dl>
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+ <h5 class="h5-returns">Returns:</h5>
565
+
566
+
567
+
568
+
569
+ <dl class="param-type">
570
+ <dt>
571
+ Type
572
+ </dt>
573
+ <dd>
574
+
575
+ <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="BTTVEmote.html">BTTVEmote</a>>></span>
576
+
577
+
578
+
579
+ </dd>
580
+ </dl>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <h4 class="name" id="fetchFFZEmotes"><span class="type-signature"></span>fetchFFZEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>>}</span></h4>
592
+
593
+
594
+
595
+
596
+
597
+
598
+ <dl class="details">
599
+
600
+ <dt class="tag-description">Description:</dt>
601
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the FFZ emotes for this channel.</p></li></ul></dd>
602
+
603
+
604
+
605
+ <dt class="tag-source">Source:</dt>
606
+ <dd class="tag-source"><ul class="dummy"><li>
607
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line42">line 42</a>
608
+ </li></ul></dd>
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+ </dl>
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+ <h5 class="h5-returns">Returns:</h5>
669
+
670
+
671
+
672
+
673
+ <dl class="param-type">
674
+ <dt>
675
+ Type
676
+ </dt>
677
+ <dd>
678
+
679
+ <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>></span>
680
+
681
+
682
+
683
+ </dd>
684
+ </dl>
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+ <h4 class="name" id="fetchSevenTVEmotes"><span class="type-signature"></span>fetchSevenTVEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="SevenTVEmote.html">SevenTVEmote</a>>>}</span></h4>
696
+
697
+
698
+
699
+
700
+
701
+
702
+ <dl class="details">
703
+
704
+ <dt class="tag-description">Description:</dt>
705
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the 7TV emotes for this channel.</p></li></ul></dd>
706
+
707
+
708
+
709
+ <dt class="tag-source">Source:</dt>
710
+ <dd class="tag-source"><ul class="dummy"><li>
711
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line50">line 50</a>
712
+ </li></ul></dd>
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+ </dl>
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+ <h5 class="h5-returns">Returns:</h5>
773
+
774
+
775
+
776
+
777
+ <dl class="param-type">
778
+ <dt>
779
+ Type
780
+ </dt>
781
+ <dd>
782
+
783
+ <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="SevenTVEmote.html">SevenTVEmote</a>>></span>
784
+
785
+
786
+
787
+ </dd>
788
+ </dl>
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+ </article>
801
+
802
+ </section>
803
+
804
+
805
+
806
+
807
+
808
+
809
+ </div>
810
+
811
+ <br class="clear">
812
+
813
+ <footer>
814
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
815
+ </footer>
816
+
817
+ <script>prettyPrint();</script>
818
+ <script src="scripts/polyfill.js"></script>
819
+ <script src="scripts/linenumber.js"></script>
820
+
821
+
822
+
823
+ </body>
701
824
  </html>