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