@mkody/twitch-emoticons 2.7.0 → 2.8.0

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 (45) 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/README.md +36 -4
  11. package/docs/BTTVEmote.html +1641 -1319
  12. package/docs/Channel.html +823 -823
  13. package/docs/Collection.html +797 -797
  14. package/docs/Emote.html +906 -801
  15. package/docs/EmoteFetcher.html +3680 -2946
  16. package/docs/EmoteParser.html +811 -811
  17. package/docs/FFZEmote.html +1795 -1473
  18. package/docs/SevenTV.html +1190 -1190
  19. package/docs/SevenTVEmote.html +1705 -1395
  20. package/docs/TwitchEmote.html +1637 -1315
  21. package/docs/index.html +230 -206
  22. package/docs/struct_BTTVEmote.js.html +162 -132
  23. package/docs/struct_Channel.js.html +127 -127
  24. package/docs/struct_Emote.js.html +151 -138
  25. package/docs/struct_EmoteFetcher.js.html +427 -399
  26. package/docs/struct_EmoteParser.js.html +153 -153
  27. package/docs/struct_FFZEmote.js.html +185 -146
  28. package/docs/struct_SevenTVEmote.js.html +178 -141
  29. package/docs/struct_TwitchEmote.js.html +159 -130
  30. package/docs/util_Collection.js.html +150 -150
  31. package/package.json +57 -57
  32. package/src/index.js +12 -12
  33. package/src/struct/BTTVEmote.js +90 -60
  34. package/src/struct/Channel.js +55 -55
  35. package/src/struct/Emote.js +79 -66
  36. package/src/struct/EmoteFetcher.js +355 -327
  37. package/src/struct/EmoteParser.js +81 -81
  38. package/src/struct/EmoteTypeMapper.js +13 -0
  39. package/src/struct/FFZEmote.js +113 -74
  40. package/src/struct/SevenTVEmote.js +106 -69
  41. package/src/struct/TwitchEmote.js +87 -58
  42. package/src/util/Collection.js +78 -78
  43. package/src/util/Constants.js +31 -31
  44. package/test/index.js +482 -174
  45. package/typings/index.d.ts +115 -98
package/docs/BTTVEmote.html CHANGED
@@ -1,1320 +1,1642 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>BTTVEmote - 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">BTTVEmote</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
-
48
- <header>
49
-
50
- <h2>
51
-
52
- BTTVEmote
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="BTTVEmote"><span class="type-signature"></span>new BTTVEmote<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>A BTTV emote.</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_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line5">line 5</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>channel</code></td>
156
-
157
-
158
- <td class="type">
159
-
160
-
161
- <span class="param-type"><a href="Channel.html">Channel</a></span>
162
-
163
-
164
-
165
-
166
- </td>
167
-
168
-
169
-
170
-
171
-
172
- <td class="description last"><p>Channel this emote belongs to.</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">string</span>
186
-
187
-
188
-
189
-
190
- </td>
191
-
192
-
193
-
194
-
195
-
196
- <td class="description last"><p>ID of the emote.</p></td>
197
- </tr>
198
-
199
-
200
-
201
- <tr>
202
-
203
- <td class="name"><code>data</code></td>
204
-
205
-
206
- <td class="type">
207
-
208
-
209
- <span class="param-type">data</span>
210
-
211
-
212
-
213
-
214
- </td>
215
-
216
-
217
-
218
-
219
-
220
- <td class="description last"><p>The raw emote data.</p></td>
221
- </tr>
222
-
223
-
224
- </tbody>
225
- </table>
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
- </div>
247
-
248
-
249
-
250
- <h3 class="subsection-title">Extends</h3>
251
-
252
-
253
-
254
-
255
- <ul>
256
- <li><a href="Emote.html">Emote</a></li>
257
- </ul>
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
- <h3 class="subsection-title">Members</h3>
274
-
275
-
276
-
277
- <h4 class="name" id="animated"><span class="type-signature"></span>animated<span class="type-signature"> :boolean</span></h4>
278
-
279
-
280
-
281
-
282
-
283
- <dl class="details">
284
-
285
- <dt class="tag-description">Description:</dt>
286
- <dd class="tag-description"><ul class="dummy"><li><p>If emote is animated.</p></li></ul></dd>
287
-
288
-
289
-
290
- <dt class="tag-source">Source:</dt>
291
- <dd class="tag-source"><ul class="dummy"><li>
292
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line41">line 41</a>
293
- </li></ul></dd>
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
- </dl>
326
-
327
-
328
-
329
-
330
-
331
- <div class="description usertext">
332
- <p>If emote is animated.</p>
333
- </div>
334
-
335
-
336
-
337
- <h5 class="h5-types">Type:</h5>
338
- <ul>
339
- <li>
340
-
341
- <span class="param-type">boolean</span>
342
-
343
-
344
-
345
- </li>
346
- </ul>
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
- <h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
356
-
357
-
358
-
359
-
360
-
361
- <dl class="details">
362
-
363
- <dt class="tag-description">Description:</dt>
364
- <dd class="tag-description"><ul class="dummy"><li><p>The channel this emote belongs to.<br>
365
- Only accurate and constant on Twitch emotes.<br>
366
- For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
367
-
368
-
369
-
370
- <dt class="tag-source">Source:</dt>
371
- <dd class="tag-source"><ul class="dummy"><li>
372
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line26">line 26</a>
373
- </li></ul></dd>
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
- <dt class="tag-overrides">Overrides:</dt>
384
- <dd class="tag-overrides"><ul class="dummy"><li>
385
- <a href="Emote.html#channel">Emote#channel</a>
386
- </li></ul></dd>
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
- </dl>
411
-
412
-
413
-
414
-
415
-
416
- <div class="description usertext">
417
- <p>The channel this emote belongs to.<br>
418
- Only accurate and constant on Twitch emotes.<br>
419
- For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
420
- </div>
421
-
422
-
423
-
424
- <h5 class="h5-types">Type:</h5>
425
- <ul>
426
- <li>
427
-
428
- <span class="param-type"><a href="Channel.html">Channel</a></span>
429
-
430
-
431
-
432
- </li>
433
- </ul>
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
- <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
443
-
444
-
445
-
446
-
447
-
448
- <dl class="details">
449
-
450
- <dt class="tag-description">Description:</dt>
451
- <dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
452
-
453
-
454
-
455
- <dt class="tag-source">Source:</dt>
456
- <dd class="tag-source"><ul class="dummy"><li>
457
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line49">line 49</a>
458
- </li></ul></dd>
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
- <dt class="tag-overrides">Overrides:</dt>
469
- <dd class="tag-overrides"><ul class="dummy"><li>
470
- <a href="Emote.html#code">Emote#code</a>
471
- </li></ul></dd>
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
- </dl>
496
-
497
-
498
-
499
-
500
-
501
- <div class="description usertext">
502
- <p>The code or name of the emote.</p>
503
- </div>
504
-
505
-
506
-
507
- <h5 class="h5-types">Type:</h5>
508
- <ul>
509
- <li>
510
-
511
- <span class="param-type">string</span>
512
-
513
-
514
-
515
- </li>
516
- </ul>
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
- <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
526
-
527
-
528
-
529
-
530
-
531
- <dl class="details">
532
-
533
- <dt class="tag-description">Description:</dt>
534
- <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
535
-
536
-
537
-
538
- <dt class="tag-source">Source:</dt>
539
- <dd class="tag-source"><ul class="dummy"><li>
540
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line18">line 18</a>
541
- </li></ul></dd>
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
- <dt class="tag-overrides">Overrides:</dt>
552
- <dd class="tag-overrides"><ul class="dummy"><li>
553
- <a href="Emote.html#fetcher">Emote#fetcher</a>
554
- </li></ul></dd>
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
-
578
- </dl>
579
-
580
-
581
-
582
-
583
-
584
- <div class="description usertext">
585
- <p>The emote fetcher.</p>
586
- </div>
587
-
588
-
589
-
590
- <h5 class="h5-types">Type:</h5>
591
- <ul>
592
- <li>
593
-
594
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
595
-
596
-
597
-
598
- </li>
599
- </ul>
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
- <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
609
-
610
-
611
-
612
-
613
-
614
- <dl class="details">
615
-
616
- <dt class="tag-description">Description:</dt>
617
- <dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
618
-
619
-
620
-
621
- <dt class="tag-source">Source:</dt>
622
- <dd class="tag-source"><ul class="dummy"><li>
623
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line32">line 32</a>
624
- </li></ul></dd>
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
- <dt class="tag-overrides">Overrides:</dt>
635
- <dd class="tag-overrides"><ul class="dummy"><li>
636
- <a href="Emote.html#id">Emote#id</a>
637
- </li></ul></dd>
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
-
660
-
661
- </dl>
662
-
663
-
664
-
665
-
666
-
667
- <div class="description usertext">
668
- <p>The ID of this emote.</p>
669
- </div>
670
-
671
-
672
-
673
- <h5 class="h5-types">Type:</h5>
674
- <ul>
675
- <li>
676
-
677
- <span class="param-type">string</span>
678
-
679
-
680
-
681
- </li>
682
- </ul>
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
- <h4 class="name" id="imageType"><span class="type-signature"></span>imageType<span class="type-signature"> :string</span></h4>
692
-
693
-
694
-
695
-
696
-
697
- <dl class="details">
698
-
699
- <dt class="tag-description">Description:</dt>
700
- <dd class="tag-description"><ul class="dummy"><li><p>The image type of the emote.</p></li></ul></dd>
701
-
702
-
703
-
704
- <dt class="tag-source">Source:</dt>
705
- <dd class="tag-source"><ul class="dummy"><li>
706
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line47">line 47</a>
707
- </li></ul></dd>
708
-
709
-
710
-
711
-
712
-
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
- </dl>
740
-
741
-
742
-
743
-
744
-
745
- <div class="description usertext">
746
- <p>The image type of the emote.</p>
747
- </div>
748
-
749
-
750
-
751
- <h5 class="h5-types">Type:</h5>
752
- <ul>
753
- <li>
754
-
755
- <span class="param-type">string</span>
756
-
757
-
758
-
759
- </li>
760
- </ul>
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
- <h4 class="name" id="owner"><span class="type-signature type-signature-readonly, nullable">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
770
-
771
-
772
-
773
-
774
-
775
- <dl class="details">
776
-
777
- <dt class="tag-description">Description:</dt>
778
- <dd class="tag-description"><ul class="dummy"><li><p>The channel of this emote's creator.<br>
779
- Not guaranteed to contain the emote, or be cached.</p></li></ul></dd>
780
-
781
-
782
-
783
- <dt class="tag-source">Source:</dt>
784
- <dd class="tag-source"><ul class="dummy"><li>
785
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line23">line 23</a>
786
- </li></ul></dd>
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
-
795
-
796
-
797
-
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
-
806
-
807
-
808
-
809
-
810
-
811
-
812
-
813
-
814
-
815
-
816
-
817
-
818
- </dl>
819
-
820
-
821
-
822
-
823
-
824
- <div class="description usertext">
825
- <p>The channel of this emote's creator.<br>
826
- Not guaranteed to contain the emote, or be cached.</p>
827
- </div>
828
-
829
-
830
-
831
- <h5 class="h5-types">Type:</h5>
832
- <ul>
833
- <li>
834
-
835
- <span class="param-type"><a href="Channel.html">Channel</a></span>
836
-
837
-
838
-
839
- </li>
840
- </ul>
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
- <h4 class="name" id="ownerName"><span class="type-signature type-signature-nullable">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
850
-
851
-
852
-
853
-
854
-
855
- <dl class="details">
856
-
857
- <dt class="tag-description">Description:</dt>
858
- <dd class="tag-description"><ul class="dummy"><li><p>The name of the emote creator's channel.<br>
859
- Will be null for global or channel emotes.</p></li></ul></dd>
860
-
861
-
862
-
863
- <dt class="tag-source">Source:</dt>
864
- <dd class="tag-source"><ul class="dummy"><li>
865
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line35">line 35</a>
866
- </li></ul></dd>
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
-
894
-
895
-
896
-
897
-
898
- </dl>
899
-
900
-
901
-
902
-
903
-
904
- <div class="description usertext">
905
- <p>The name of the emote creator's channel.<br>
906
- Will be null for global or channel emotes.</p>
907
- </div>
908
-
909
-
910
-
911
- <h5 class="h5-types">Type:</h5>
912
- <ul>
913
- <li>
914
-
915
- <span class="param-type">string</span>
916
-
917
-
918
-
919
- </li>
920
- </ul>
921
-
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
- <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
930
-
931
-
932
-
933
-
934
-
935
- <dl class="details">
936
-
937
- <dt class="tag-description">Description:</dt>
938
- <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
939
- Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
940
-
941
-
942
-
943
- <dt class="tag-source">Source:</dt>
944
- <dd class="tag-source"><ul class="dummy"><li>
945
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line39">line 39</a>
946
- </li></ul></dd>
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
- <dt class="tag-overrides">Overrides:</dt>
957
- <dd class="tag-overrides"><ul class="dummy"><li>
958
- <a href="Emote.html#type">Emote#type</a>
959
- </li></ul></dd>
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
- </dl>
984
-
985
-
986
-
987
-
988
-
989
- <div class="description usertext">
990
- <p>The type of this emote.<br>
991
- Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
992
- </div>
993
-
994
-
995
-
996
- <h5 class="h5-types">Type:</h5>
997
- <ul>
998
- <li>
999
-
1000
- <span class="param-type">string</span>
1001
-
1002
-
1003
-
1004
- </li>
1005
- </ul>
1006
-
1007
-
1008
-
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
-
1016
- <h3 class="subsection-title">Methods</h3>
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
- <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
1024
-
1025
-
1026
-
1027
-
1028
-
1029
-
1030
- <dl class="details">
1031
-
1032
- <dt class="tag-description">Description:</dt>
1033
- <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
1034
-
1035
-
1036
-
1037
- <dt class="tag-source">Source:</dt>
1038
- <dd class="tag-source"><ul class="dummy"><li>
1039
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line55">line 55</a>
1040
- </li></ul></dd>
1041
-
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
- </dl>
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
-
1080
-
1081
-
1082
-
1083
-
1084
-
1085
-
1086
- <h5 class="h5-parameters">Parameters:</h5>
1087
-
1088
-
1089
- <table class="params">
1090
- <thead>
1091
- <tr>
1092
-
1093
- <th>Name</th>
1094
-
1095
-
1096
- <th>Type</th>
1097
-
1098
-
1099
-
1100
-
1101
- <th>Default</th>
1102
-
1103
-
1104
- <th class="last">Description</th>
1105
- </tr>
1106
- </thead>
1107
-
1108
- <tbody>
1109
-
1110
-
1111
- <tr>
1112
-
1113
- <td class="name"><code>size</code></td>
1114
-
1115
-
1116
- <td class="type">
1117
-
1118
-
1119
- <span class="param-type">number</span>
1120
-
1121
-
1122
-
1123
-
1124
- </td>
1125
-
1126
-
1127
-
1128
-
1129
- <td class="default">
1130
-
1131
- <code>0</code>
1132
-
1133
- </td>
1134
-
1135
-
1136
- <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
1137
- </tr>
1138
-
1139
-
1140
- </tbody>
1141
- </table>
1142
-
1143
-
1144
-
1145
-
1146
-
1147
-
1148
-
1149
-
1150
-
1151
-
1152
-
1153
-
1154
-
1155
-
1156
-
1157
-
1158
- <h5 class="h5-returns">Returns:</h5>
1159
-
1160
-
1161
-
1162
-
1163
- <dl class="param-type">
1164
- <dt>
1165
- Type
1166
- </dt>
1167
- <dd>
1168
-
1169
- <span class="param-type">string</span>
1170
-
1171
-
1172
-
1173
- </dd>
1174
- </dl>
1175
-
1176
-
1177
-
1178
-
1179
-
1180
-
1181
-
1182
-
1183
-
1184
-
1185
- <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1186
-
1187
-
1188
-
1189
-
1190
-
1191
-
1192
- <dl class="details">
1193
-
1194
- <dt class="tag-description">Description:</dt>
1195
- <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
1196
- Will give the emote's name.</p></li></ul></dd>
1197
-
1198
-
1199
-
1200
- <dt class="tag-source">Source:</dt>
1201
- <dd class="tag-source"><ul class="dummy"><li>
1202
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line61">line 61</a>
1203
- </li></ul></dd>
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
-
1212
-
1213
- <dt class="tag-overrides">Overrides:</dt>
1214
- <dd class="tag-overrides"><ul class="dummy"><li>
1215
- <a href="Emote.html#toString">Emote#toString</a>
1216
- </li></ul></dd>
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
-
1238
-
1239
-
1240
- </dl>
1241
-
1242
-
1243
-
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
-
1267
-
1268
- <h5 class="h5-returns">Returns:</h5>
1269
-
1270
-
1271
-
1272
-
1273
- <dl class="param-type">
1274
- <dt>
1275
- Type
1276
- </dt>
1277
- <dd>
1278
-
1279
- <span class="param-type">string</span>
1280
-
1281
-
1282
-
1283
- </dd>
1284
- </dl>
1285
-
1286
-
1287
-
1288
-
1289
-
1290
-
1291
-
1292
-
1293
-
1294
-
1295
-
1296
- </article>
1297
-
1298
- </section>
1299
-
1300
-
1301
-
1302
-
1303
-
1304
-
1305
- </div>
1306
-
1307
- <br class="clear">
1308
-
1309
- <footer>
1310
- 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.
1311
- </footer>
1312
-
1313
- <script>prettyPrint();</script>
1314
- <script src="scripts/polyfill.js"></script>
1315
- <script src="scripts/linenumber.js"></script>
1316
-
1317
-
1318
-
1319
- </body>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>BTTVEmote - 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#toObject">toObject</a></li><li data-type='method'><a href="BTTVEmote.html#toString">toString</a></li><li data-type='method'><a href="BTTVEmote.html#.fromObject">fromObject</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#toObject">toObject</a></li><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#_setupChannel">_setupChannel</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><li data-type='method'><a href="EmoteFetcher.html#fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="FFZEmote.html#toString">toString</a></li><li data-type='method'><a href="FFZEmote.html#.fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="SevenTVEmote.html#toString">toString</a></li><li data-type='method'><a href="SevenTVEmote.html#.fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="TwitchEmote.html#toString">toString</a></li><li data-type='method'><a href="TwitchEmote.html#.fromObject">fromObject</a></li></ul></li></ul>
33
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">BTTVEmote</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+ <h2>
51
+
52
+ BTTVEmote
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="BTTVEmote"><span class="type-signature"></span>new BTTVEmote<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>A BTTV emote.</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_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line5">line 5</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>channel</code></td>
156
+
157
+
158
+ <td class="type">
159
+
160
+
161
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
162
+
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last"><p>Channel this emote belongs to.</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">string</span>
186
+
187
+
188
+
189
+
190
+ </td>
191
+
192
+
193
+
194
+
195
+
196
+ <td class="description last"><p>ID of the emote.</p></td>
197
+ </tr>
198
+
199
+
200
+
201
+ <tr>
202
+
203
+ <td class="name"><code>data</code></td>
204
+
205
+
206
+ <td class="type">
207
+
208
+
209
+ <span class="param-type">data</span>
210
+
211
+
212
+
213
+
214
+ </td>
215
+
216
+
217
+
218
+
219
+
220
+ <td class="description last"><p>The raw emote data.</p></td>
221
+ </tr>
222
+
223
+
224
+ </tbody>
225
+ </table>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ </div>
247
+
248
+
249
+
250
+ <h3 class="subsection-title">Extends</h3>
251
+
252
+
253
+
254
+
255
+ <ul>
256
+ <li><a href="Emote.html">Emote</a></li>
257
+ </ul>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <h3 class="subsection-title">Members</h3>
274
+
275
+
276
+
277
+ <h4 class="name" id="animated"><span class="type-signature"></span>animated<span class="type-signature"> :boolean</span></h4>
278
+
279
+
280
+
281
+
282
+
283
+ <dl class="details">
284
+
285
+ <dt class="tag-description">Description:</dt>
286
+ <dd class="tag-description"><ul class="dummy"><li><p>If emote is animated.</p></li></ul></dd>
287
+
288
+
289
+
290
+ <dt class="tag-source">Source:</dt>
291
+ <dd class="tag-source"><ul class="dummy"><li>
292
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line41">line 41</a>
293
+ </li></ul></dd>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+ </dl>
326
+
327
+
328
+
329
+
330
+
331
+ <div class="description usertext">
332
+ <p>If emote is animated.</p>
333
+ </div>
334
+
335
+
336
+
337
+ <h5 class="h5-types">Type:</h5>
338
+ <ul>
339
+ <li>
340
+
341
+ <span class="param-type">boolean</span>
342
+
343
+
344
+
345
+ </li>
346
+ </ul>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+ <h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
356
+
357
+
358
+
359
+
360
+
361
+ <dl class="details">
362
+
363
+ <dt class="tag-description">Description:</dt>
364
+ <dd class="tag-description"><ul class="dummy"><li><p>The channel this emote belongs to.<br>
365
+ Only accurate and constant on Twitch emotes.<br>
366
+ For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
367
+
368
+
369
+
370
+ <dt class="tag-source">Source:</dt>
371
+ <dd class="tag-source"><ul class="dummy"><li>
372
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line26">line 26</a>
373
+ </li></ul></dd>
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+ <dt class="tag-overrides">Overrides:</dt>
384
+ <dd class="tag-overrides"><ul class="dummy"><li>
385
+ <a href="Emote.html#channel">Emote#channel</a>
386
+ </li></ul></dd>
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+ </dl>
411
+
412
+
413
+
414
+
415
+
416
+ <div class="description usertext">
417
+ <p>The channel this emote belongs to.<br>
418
+ Only accurate and constant on Twitch emotes.<br>
419
+ For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
420
+ </div>
421
+
422
+
423
+
424
+ <h5 class="h5-types">Type:</h5>
425
+ <ul>
426
+ <li>
427
+
428
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
429
+
430
+
431
+
432
+ </li>
433
+ </ul>
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
443
+
444
+
445
+
446
+
447
+
448
+ <dl class="details">
449
+
450
+ <dt class="tag-description">Description:</dt>
451
+ <dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
452
+
453
+
454
+
455
+ <dt class="tag-source">Source:</dt>
456
+ <dd class="tag-source"><ul class="dummy"><li>
457
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line49">line 49</a>
458
+ </li></ul></dd>
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <dt class="tag-overrides">Overrides:</dt>
469
+ <dd class="tag-overrides"><ul class="dummy"><li>
470
+ <a href="Emote.html#code">Emote#code</a>
471
+ </li></ul></dd>
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ </dl>
496
+
497
+
498
+
499
+
500
+
501
+ <div class="description usertext">
502
+ <p>The code or name of the emote.</p>
503
+ </div>
504
+
505
+
506
+
507
+ <h5 class="h5-types">Type:</h5>
508
+ <ul>
509
+ <li>
510
+
511
+ <span class="param-type">string</span>
512
+
513
+
514
+
515
+ </li>
516
+ </ul>
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+ <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
526
+
527
+
528
+
529
+
530
+
531
+ <dl class="details">
532
+
533
+ <dt class="tag-description">Description:</dt>
534
+ <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
535
+
536
+
537
+
538
+ <dt class="tag-source">Source:</dt>
539
+ <dd class="tag-source"><ul class="dummy"><li>
540
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line18">line 18</a>
541
+ </li></ul></dd>
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+ <dt class="tag-overrides">Overrides:</dt>
552
+ <dd class="tag-overrides"><ul class="dummy"><li>
553
+ <a href="Emote.html#fetcher">Emote#fetcher</a>
554
+ </li></ul></dd>
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+ </dl>
579
+
580
+
581
+
582
+
583
+
584
+ <div class="description usertext">
585
+ <p>The emote fetcher.</p>
586
+ </div>
587
+
588
+
589
+
590
+ <h5 class="h5-types">Type:</h5>
591
+ <ul>
592
+ <li>
593
+
594
+ <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
595
+
596
+
597
+
598
+ </li>
599
+ </ul>
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+ <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
609
+
610
+
611
+
612
+
613
+
614
+ <dl class="details">
615
+
616
+ <dt class="tag-description">Description:</dt>
617
+ <dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
618
+
619
+
620
+
621
+ <dt class="tag-source">Source:</dt>
622
+ <dd class="tag-source"><ul class="dummy"><li>
623
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line32">line 32</a>
624
+ </li></ul></dd>
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+ <dt class="tag-overrides">Overrides:</dt>
635
+ <dd class="tag-overrides"><ul class="dummy"><li>
636
+ <a href="Emote.html#id">Emote#id</a>
637
+ </li></ul></dd>
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ </dl>
662
+
663
+
664
+
665
+
666
+
667
+ <div class="description usertext">
668
+ <p>The ID of this emote.</p>
669
+ </div>
670
+
671
+
672
+
673
+ <h5 class="h5-types">Type:</h5>
674
+ <ul>
675
+ <li>
676
+
677
+ <span class="param-type">string</span>
678
+
679
+
680
+
681
+ </li>
682
+ </ul>
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+ <h4 class="name" id="imageType"><span class="type-signature"></span>imageType<span class="type-signature"> :string</span></h4>
692
+
693
+
694
+
695
+
696
+
697
+ <dl class="details">
698
+
699
+ <dt class="tag-description">Description:</dt>
700
+ <dd class="tag-description"><ul class="dummy"><li><p>The image type of the emote.</p></li></ul></dd>
701
+
702
+
703
+
704
+ <dt class="tag-source">Source:</dt>
705
+ <dd class="tag-source"><ul class="dummy"><li>
706
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line47">line 47</a>
707
+ </li></ul></dd>
708
+
709
+
710
+
711
+
712
+
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
+ </dl>
740
+
741
+
742
+
743
+
744
+
745
+ <div class="description usertext">
746
+ <p>The image type of the emote.</p>
747
+ </div>
748
+
749
+
750
+
751
+ <h5 class="h5-types">Type:</h5>
752
+ <ul>
753
+ <li>
754
+
755
+ <span class="param-type">string</span>
756
+
757
+
758
+
759
+ </li>
760
+ </ul>
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+ <h4 class="name" id="owner"><span class="type-signature type-signature-readonly, nullable">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
770
+
771
+
772
+
773
+
774
+
775
+ <dl class="details">
776
+
777
+ <dt class="tag-description">Description:</dt>
778
+ <dd class="tag-description"><ul class="dummy"><li><p>The channel of this emote's creator.<br>
779
+ Not guaranteed to contain the emote, or be cached.</p></li></ul></dd>
780
+
781
+
782
+
783
+ <dt class="tag-source">Source:</dt>
784
+ <dd class="tag-source"><ul class="dummy"><li>
785
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line23">line 23</a>
786
+ </li></ul></dd>
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+ </dl>
819
+
820
+
821
+
822
+
823
+
824
+ <div class="description usertext">
825
+ <p>The channel of this emote's creator.<br>
826
+ Not guaranteed to contain the emote, or be cached.</p>
827
+ </div>
828
+
829
+
830
+
831
+ <h5 class="h5-types">Type:</h5>
832
+ <ul>
833
+ <li>
834
+
835
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
836
+
837
+
838
+
839
+ </li>
840
+ </ul>
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <h4 class="name" id="ownerName"><span class="type-signature type-signature-nullable">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
850
+
851
+
852
+
853
+
854
+
855
+ <dl class="details">
856
+
857
+ <dt class="tag-description">Description:</dt>
858
+ <dd class="tag-description"><ul class="dummy"><li><p>The name of the emote creator's channel.<br>
859
+ Will be null for global or channel emotes.</p></li></ul></dd>
860
+
861
+
862
+
863
+ <dt class="tag-source">Source:</dt>
864
+ <dd class="tag-source"><ul class="dummy"><li>
865
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line35">line 35</a>
866
+ </li></ul></dd>
867
+
868
+
869
+
870
+
871
+
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+ </dl>
899
+
900
+
901
+
902
+
903
+
904
+ <div class="description usertext">
905
+ <p>The name of the emote creator's channel.<br>
906
+ Will be null for global or channel emotes.</p>
907
+ </div>
908
+
909
+
910
+
911
+ <h5 class="h5-types">Type:</h5>
912
+ <ul>
913
+ <li>
914
+
915
+ <span class="param-type">string</span>
916
+
917
+
918
+
919
+ </li>
920
+ </ul>
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+ <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
930
+
931
+
932
+
933
+
934
+
935
+ <dl class="details">
936
+
937
+ <dt class="tag-description">Description:</dt>
938
+ <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
939
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
940
+
941
+
942
+
943
+ <dt class="tag-source">Source:</dt>
944
+ <dd class="tag-source"><ul class="dummy"><li>
945
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line39">line 39</a>
946
+ </li></ul></dd>
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+ <dt class="tag-overrides">Overrides:</dt>
957
+ <dd class="tag-overrides"><ul class="dummy"><li>
958
+ <a href="Emote.html#type">Emote#type</a>
959
+ </li></ul></dd>
960
+
961
+
962
+
963
+
964
+
965
+
966
+
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+
975
+
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+ </dl>
984
+
985
+
986
+
987
+
988
+
989
+ <div class="description usertext">
990
+ <p>The type of this emote.<br>
991
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
992
+ </div>
993
+
994
+
995
+
996
+ <h5 class="h5-types">Type:</h5>
997
+ <ul>
998
+ <li>
999
+
1000
+ <span class="param-type">string</span>
1001
+
1002
+
1003
+
1004
+ </li>
1005
+ </ul>
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+ <h3 class="subsection-title">Methods</h3>
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+ <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+ <dl class="details">
1031
+
1032
+ <dt class="tag-description">Description:</dt>
1033
+ <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
1034
+
1035
+
1036
+
1037
+ <dt class="tag-source">Source:</dt>
1038
+ <dd class="tag-source"><ul class="dummy"><li>
1039
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line55">line 55</a>
1040
+ </li></ul></dd>
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+ </dl>
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+ <h5 class="h5-parameters">Parameters:</h5>
1087
+
1088
+
1089
+ <table class="params">
1090
+ <thead>
1091
+ <tr>
1092
+
1093
+ <th>Name</th>
1094
+
1095
+
1096
+ <th>Type</th>
1097
+
1098
+
1099
+
1100
+
1101
+ <th>Default</th>
1102
+
1103
+
1104
+ <th class="last">Description</th>
1105
+ </tr>
1106
+ </thead>
1107
+
1108
+ <tbody>
1109
+
1110
+
1111
+ <tr>
1112
+
1113
+ <td class="name"><code>size</code></td>
1114
+
1115
+
1116
+ <td class="type">
1117
+
1118
+
1119
+ <span class="param-type">number</span>
1120
+
1121
+
1122
+
1123
+
1124
+ </td>
1125
+
1126
+
1127
+
1128
+
1129
+ <td class="default">
1130
+
1131
+ <code>0</code>
1132
+
1133
+ </td>
1134
+
1135
+
1136
+ <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
1137
+ </tr>
1138
+
1139
+
1140
+ </tbody>
1141
+ </table>
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+ <h5 class="h5-returns">Returns:</h5>
1159
+
1160
+
1161
+
1162
+
1163
+ <dl class="param-type">
1164
+ <dt>
1165
+ Type
1166
+ </dt>
1167
+ <dd>
1168
+
1169
+ <span class="param-type">string</span>
1170
+
1171
+
1172
+
1173
+ </dd>
1174
+ </dl>
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+ <h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+ <dl class="details">
1193
+
1194
+ <dt class="tag-description">Description:</dt>
1195
+ <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toObject</code>.<br>
1196
+ Will result in an Object representation of a BTTVEmote</p></li></ul></dd>
1197
+
1198
+
1199
+
1200
+ <dt class="tag-source">Source:</dt>
1201
+ <dd class="tag-source"><ul class="dummy"><li>
1202
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line64">line 64</a>
1203
+ </li></ul></dd>
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+ <dt class="tag-overrides">Overrides:</dt>
1214
+ <dd class="tag-overrides"><ul class="dummy"><li>
1215
+ <a href="Emote.html#toObject">Emote#toObject</a>
1216
+ </li></ul></dd>
1217
+
1218
+
1219
+
1220
+
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+ </dl>
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+ <h5 class="h5-returns">Returns:</h5>
1269
+
1270
+
1271
+
1272
+
1273
+ <dl class="param-type">
1274
+ <dt>
1275
+ Type
1276
+ </dt>
1277
+ <dd>
1278
+
1279
+ <span class="param-type">Object</span>
1280
+
1281
+
1282
+
1283
+ </dd>
1284
+ </dl>
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+ <dl class="details">
1303
+
1304
+ <dt class="tag-description">Description:</dt>
1305
+ <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
1306
+ Will give the emote's name.</p></li></ul></dd>
1307
+
1308
+
1309
+
1310
+ <dt class="tag-source">Source:</dt>
1311
+ <dd class="tag-source"><ul class="dummy"><li>
1312
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line61">line 61</a>
1313
+ </li></ul></dd>
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+ <dt class="tag-overrides">Overrides:</dt>
1324
+ <dd class="tag-overrides"><ul class="dummy"><li>
1325
+ <a href="Emote.html#toString">Emote#toString</a>
1326
+ </li></ul></dd>
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+ </dl>
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+ <h5 class="h5-returns">Returns:</h5>
1379
+
1380
+
1381
+
1382
+
1383
+ <dl class="param-type">
1384
+ <dt>
1385
+ Type
1386
+ </dt>
1387
+ <dd>
1388
+
1389
+ <span class="param-type">string</span>
1390
+
1391
+
1392
+
1393
+ </dd>
1394
+ </dl>
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+ <h4 class="name" id=".fromObject"><span class="type-signature type-signature-static">(static) </span>fromObject<span class="signature">(emoteObject<span class="signature-attributes">opt</span>, channel<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BTTVEmote.html">BTTVEmote</a>}</span></h4>
1406
+
1407
+
1408
+
1409
+
1410
+
1411
+
1412
+ <dl class="details">
1413
+
1414
+ <dt class="tag-description">Description:</dt>
1415
+ <dd class="tag-description"><ul class="dummy"><li><p>Converts an emote Object into a BTTVEmote</p></li></ul></dd>
1416
+
1417
+
1418
+
1419
+ <dt class="tag-source">Source:</dt>
1420
+ <dd class="tag-source"><ul class="dummy"><li>
1421
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line78">line 78</a>
1422
+ </li></ul></dd>
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+ </dl>
1455
+
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+ <h5 class="h5-parameters">Parameters:</h5>
1469
+
1470
+
1471
+ <table class="params">
1472
+ <thead>
1473
+ <tr>
1474
+
1475
+ <th>Name</th>
1476
+
1477
+
1478
+ <th>Type</th>
1479
+
1480
+
1481
+ <th>Attributes</th>
1482
+
1483
+
1484
+
1485
+ <th>Default</th>
1486
+
1487
+
1488
+ <th class="last">Description</th>
1489
+ </tr>
1490
+ </thead>
1491
+
1492
+ <tbody>
1493
+
1494
+
1495
+ <tr>
1496
+
1497
+ <td class="name"><code>emoteObject</code></td>
1498
+
1499
+
1500
+ <td class="type">
1501
+
1502
+
1503
+ <span class="param-type">Object</span>
1504
+
1505
+
1506
+
1507
+
1508
+ </td>
1509
+
1510
+
1511
+ <td class="attributes">
1512
+
1513
+ &lt;optional><br>
1514
+
1515
+
1516
+
1517
+
1518
+
1519
+ </td>
1520
+
1521
+
1522
+
1523
+ <td class="default">
1524
+
1525
+ </td>
1526
+
1527
+
1528
+ <td class="description last"><p>Object representation of this emote</p></td>
1529
+ </tr>
1530
+
1531
+
1532
+
1533
+ <tr>
1534
+
1535
+ <td class="name"><code>channel</code></td>
1536
+
1537
+
1538
+ <td class="type">
1539
+
1540
+
1541
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
1542
+
1543
+
1544
+
1545
+
1546
+ </td>
1547
+
1548
+
1549
+ <td class="attributes">
1550
+
1551
+ &lt;optional><br>
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+ </td>
1558
+
1559
+
1560
+
1561
+ <td class="default">
1562
+
1563
+ <code>null</code>
1564
+
1565
+ </td>
1566
+
1567
+
1568
+ <td class="description last"><p>Channel this emote belongs to.</p></td>
1569
+ </tr>
1570
+
1571
+
1572
+ </tbody>
1573
+ </table>
1574
+
1575
+
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+ <h5 class="h5-returns">Returns:</h5>
1591
+
1592
+
1593
+
1594
+
1595
+ <dl class="param-type">
1596
+ <dt>
1597
+ Type
1598
+ </dt>
1599
+ <dd>
1600
+
1601
+ <span class="param-type"><a href="BTTVEmote.html">BTTVEmote</a></span>
1602
+
1603
+
1604
+
1605
+ </dd>
1606
+ </dl>
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+
1617
+
1618
+ </article>
1619
+
1620
+ </section>
1621
+
1622
+
1623
+
1624
+
1625
+
1626
+
1627
+ </div>
1628
+
1629
+ <br class="clear">
1630
+
1631
+ <footer>
1632
+ 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.
1633
+ </footer>
1634
+
1635
+ <script>prettyPrint();</script>
1636
+ <script src="scripts/polyfill.js"></script>
1637
+ <script src="scripts/linenumber.js"></script>
1638
+
1639
+
1640
+
1641
+ </body>
1320
1642
  </html>