@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
@@ -1,1192 +1,1242 @@
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
- <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">BTTVEmote</h1>
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
- <section>
44
-
45
- <header>
46
-
47
- <h2>
48
- BTTVEmote
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="BTTVEmote"><span class="type-signature"></span>new BTTVEmote<span class="signature">(channel, id, data)</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_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line5">line 5</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 BTTV emote.</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>channel</code></td>
153
-
154
-
155
- <td class="type">
156
-
157
-
158
- <span class="param-type"><a href="Channel.html">Channel</a></span>
159
-
160
-
161
-
162
- </td>
163
-
164
-
165
-
166
-
167
-
168
- <td class="description last"><p>Channel this emote belongs to.</p></td>
169
- </tr>
170
-
171
-
172
-
173
- <tr>
174
-
175
- <td class="name"><code>id</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>ID of the emote.</p></td>
192
- </tr>
193
-
194
-
195
-
196
- <tr>
197
-
198
- <td class="name"><code>data</code></td>
199
-
200
-
201
- <td class="type">
202
-
203
-
204
- <span class="param-type">data</span>
205
-
206
-
207
-
208
- </td>
209
-
210
-
211
-
212
-
213
-
214
- <td class="description last"><p>The raw emote data.</p></td>
215
- </tr>
216
-
217
-
218
- </tbody>
219
- </table>
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
- </div>
241
-
242
-
243
-
244
- <h3 class="subsection-title">Extends</h3>
245
-
246
-
247
-
248
-
249
- <ul>
250
- <li><a href="Emote.html">Emote</a></li>
251
- </ul>
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
- <h3 class="subsection-title">Members</h3>
268
-
269
-
270
-
271
- <h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
272
-
273
-
274
-
275
-
276
-
277
- <dl class="details">
278
-
279
-
280
- <dt class="tag-source">Source:</dt>
281
- <dd class="tag-source"><ul class="dummy"><li>
282
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line26">line 26</a>
283
- </li></ul></dd>
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
- <dt class="tag-overrides">Overrides:</dt>
294
- <dd class="tag-overrides"><ul class="dummy"><li>
295
- <a href="Emote.html#channel">Emote#channel</a>
296
- </li></ul></dd>
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
- </dl>
321
-
322
-
323
-
324
-
325
-
326
- <div class="description usertext">
327
- <p>The channel this emote belongs to.<br>
328
- Only accurate and constant on Twitch emotes.<br>
329
- For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
330
- </div>
331
-
332
-
333
-
334
- <h5>Type:</h5>
335
- <ul>
336
- <li>
337
-
338
- <span class="param-type"><a href="Channel.html">Channel</a></span>
339
-
340
-
341
- </li>
342
- </ul>
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
- <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
352
-
353
-
354
-
355
-
356
-
357
- <dl class="details">
358
-
359
-
360
- <dt class="tag-source">Source:</dt>
361
- <dd class="tag-source"><ul class="dummy"><li>
362
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line48">line 48</a>
363
- </li></ul></dd>
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
- <dt class="tag-overrides">Overrides:</dt>
374
- <dd class="tag-overrides"><ul class="dummy"><li>
375
- <a href="Emote.html#code">Emote#code</a>
376
- </li></ul></dd>
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
- </dl>
401
-
402
-
403
-
404
-
405
-
406
- <div class="description usertext">
407
- <p>The code or name of the emote.</p>
408
- </div>
409
-
410
-
411
-
412
- <h5>Type:</h5>
413
- <ul>
414
- <li>
415
-
416
- <span class="param-type">string</span>
417
-
418
-
419
- </li>
420
- </ul>
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
- <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
430
-
431
-
432
-
433
-
434
-
435
- <dl class="details">
436
-
437
-
438
- <dt class="tag-source">Source:</dt>
439
- <dd class="tag-source"><ul class="dummy"><li>
440
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line18">line 18</a>
441
- </li></ul></dd>
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
- <dt class="tag-overrides">Overrides:</dt>
452
- <dd class="tag-overrides"><ul class="dummy"><li>
453
- <a href="Emote.html#fetcher">Emote#fetcher</a>
454
- </li></ul></dd>
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
- </dl>
479
-
480
-
481
-
482
-
483
-
484
- <div class="description usertext">
485
- <p>The emote fetcher.</p>
486
- </div>
487
-
488
-
489
-
490
- <h5>Type:</h5>
491
- <ul>
492
- <li>
493
-
494
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
495
-
496
-
497
- </li>
498
- </ul>
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
- <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
508
-
509
-
510
-
511
-
512
-
513
- <dl class="details">
514
-
515
-
516
- <dt class="tag-source">Source:</dt>
517
- <dd class="tag-source"><ul class="dummy"><li>
518
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line32">line 32</a>
519
- </li></ul></dd>
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
- <dt class="tag-overrides">Overrides:</dt>
530
- <dd class="tag-overrides"><ul class="dummy"><li>
531
- <a href="Emote.html#id">Emote#id</a>
532
- </li></ul></dd>
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
- </dl>
557
-
558
-
559
-
560
-
561
-
562
- <div class="description usertext">
563
- <p>The ID of this emote.</p>
564
- </div>
565
-
566
-
567
-
568
- <h5>Type:</h5>
569
- <ul>
570
- <li>
571
-
572
- <span class="param-type">string</span>
573
-
574
-
575
- </li>
576
- </ul>
577
-
578
-
579
-
580
-
581
-
582
-
583
-
584
-
585
- <h4 class="name" id="imageType"><span class="type-signature"></span>imageType<span class="type-signature"> :string</span></h4>
586
-
587
-
588
-
589
-
590
-
591
- <dl class="details">
592
-
593
-
594
- <dt class="tag-source">Source:</dt>
595
- <dd class="tag-source"><ul class="dummy"><li>
596
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line41">line 41</a>
597
- </li></ul></dd>
598
-
599
-
600
-
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
- </dl>
630
-
631
-
632
-
633
-
634
-
635
- <div class="description usertext">
636
- <p>The image type of the emote.</p>
637
- </div>
638
-
639
-
640
-
641
- <h5>Type:</h5>
642
- <ul>
643
- <li>
644
-
645
- <span class="param-type">string</span>
646
-
647
-
648
- </li>
649
- </ul>
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
- <h4 class="name" id="owner"><span class="type-signature">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
659
-
660
-
661
-
662
-
663
-
664
- <dl class="details">
665
-
666
-
667
- <dt class="tag-source">Source:</dt>
668
- <dd class="tag-source"><ul class="dummy"><li>
669
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line23">line 23</a>
670
- </li></ul></dd>
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
- </dl>
703
-
704
-
705
-
706
-
707
-
708
- <div class="description usertext">
709
- <p>The channel of this emote's creator.<br>
710
- Not guaranteed to contain the emote, or be cached.</p>
711
- </div>
712
-
713
-
714
-
715
- <h5>Type:</h5>
716
- <ul>
717
- <li>
718
-
719
- <span class="param-type"><a href="Channel.html">Channel</a></span>
720
-
721
-
722
- </li>
723
- </ul>
724
-
725
-
726
-
727
-
728
-
729
-
730
-
731
-
732
- <h4 class="name" id="ownerName"><span class="type-signature">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
733
-
734
-
735
-
736
-
737
-
738
- <dl class="details">
739
-
740
-
741
- <dt class="tag-source">Source:</dt>
742
- <dd class="tag-source"><ul class="dummy"><li>
743
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line35">line 35</a>
744
- </li></ul></dd>
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
-
773
-
774
-
775
-
776
- </dl>
777
-
778
-
779
-
780
-
781
-
782
- <div class="description usertext">
783
- <p>The name of the emote creator's channel.<br>
784
- Will be null for global or channel emotes.</p>
785
- </div>
786
-
787
-
788
-
789
- <h5>Type:</h5>
790
- <ul>
791
- <li>
792
-
793
- <span class="param-type">string</span>
794
-
795
-
796
- </li>
797
- </ul>
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
-
806
- <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
807
-
808
-
809
-
810
-
811
-
812
- <dl class="details">
813
-
814
-
815
- <dt class="tag-source">Source:</dt>
816
- <dd class="tag-source"><ul class="dummy"><li>
817
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line39">line 39</a>
818
- </li></ul></dd>
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
- <dt class="tag-overrides">Overrides:</dt>
829
- <dd class="tag-overrides"><ul class="dummy"><li>
830
- <a href="Emote.html#type">Emote#type</a>
831
- </li></ul></dd>
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
- </dl>
856
-
857
-
858
-
859
-
860
-
861
- <div class="description usertext">
862
- <p>The type of this emote.<br>
863
- Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
864
- </div>
865
-
866
-
867
-
868
- <h5>Type:</h5>
869
- <ul>
870
- <li>
871
-
872
- <span class="param-type">string</span>
873
-
874
-
875
- </li>
876
- </ul>
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
- <h3 class="subsection-title">Methods</h3>
888
-
889
-
890
-
891
-
892
-
893
-
894
- <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
895
-
896
-
897
-
898
-
899
-
900
-
901
- <dl class="details">
902
-
903
-
904
- <dt class="tag-source">Source:</dt>
905
- <dd class="tag-source"><ul class="dummy"><li>
906
- <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line49">line 49</a>
907
- </li></ul></dd>
908
-
909
-
910
-
911
-
912
-
913
-
914
-
915
-
916
-
917
-
918
-
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
-
930
-
931
-
932
-
933
-
934
-
935
-
936
-
937
-
938
-
939
- </dl>
940
-
941
-
942
-
943
-
944
-
945
- <div class="description usertext">
946
- <p>Gets the image link of the emote.</p>
947
- </div>
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
- <h5>Parameters:</h5>
960
-
961
-
962
- <table class="params">
963
- <thead>
964
- <tr>
965
-
966
- <th>Name</th>
967
-
968
-
969
- <th>Type</th>
970
-
971
-
972
-
973
-
974
- <th>Default</th>
975
-
976
-
977
- <th class="last">Description</th>
978
- </tr>
979
- </thead>
980
-
981
- <tbody>
982
-
983
-
984
- <tr>
985
-
986
- <td class="name"><code>size</code></td>
987
-
988
-
989
- <td class="type">
990
-
991
-
992
- <span class="param-type">number</span>
993
-
994
-
995
-
996
- </td>
997
-
998
-
999
-
1000
-
1001
- <td class="default">
1002
-
1003
- <code>0</code>
1004
-
1005
- </td>
1006
-
1007
-
1008
- <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
1009
- </tr>
1010
-
1011
-
1012
- </tbody>
1013
- </table>
1014
-
1015
-
1016
-
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
-
1027
-
1028
-
1029
-
1030
- <h5>Returns:</h5>
1031
-
1032
-
1033
-
1034
-
1035
- <dl class="param-type">
1036
- <dt>
1037
- Type
1038
- </dt>
1039
- <dd>
1040
-
1041
- <span class="param-type">string</span>
1042
-
1043
-
1044
- </dd>
1045
- </dl>
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
- <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
- <dl class="details">
1064
-
1065
-
1066
- <dt class="tag-source">Source:</dt>
1067
- <dd class="tag-source"><ul class="dummy"><li>
1068
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line60">line 60</a>
1069
- </li></ul></dd>
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
- <dt class="tag-overrides">Overrides:</dt>
1080
- <dd class="tag-overrides"><ul class="dummy"><li>
1081
- <a href="Emote.html#toString">Emote#toString</a>
1082
- </li></ul></dd>
1083
-
1084
-
1085
-
1086
-
1087
-
1088
-
1089
-
1090
-
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
- </dl>
1107
-
1108
-
1109
-
1110
-
1111
-
1112
- <div class="description usertext">
1113
- <p>Override for <code>toString</code>.<br>
1114
- Will give the emote's name.</p>
1115
- </div>
1116
-
1117
-
1118
-
1119
-
1120
-
1121
-
1122
-
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
-
1141
- <h5>Returns:</h5>
1142
-
1143
-
1144
-
1145
-
1146
- <dl class="param-type">
1147
- <dt>
1148
- Type
1149
- </dt>
1150
- <dd>
1151
-
1152
- <span class="param-type">string</span>
1153
-
1154
-
1155
- </dd>
1156
- </dl>
1157
-
1158
-
1159
-
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
-
1167
-
1168
- </article>
1169
-
1170
- </section>
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
- </div>
1178
-
1179
- <br class="clear">
1180
-
1181
- <footer>
1182
- 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.
1183
- </footer>
1184
-
1185
- <script>prettyPrint();</script>
1186
- <script src="scripts/polyfill.js"></script>
1187
- <script src="scripts/linenumber.js"></script>
1188
-
1189
-
1190
-
1191
- </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">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">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="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></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>The channel this emote belongs to.<br>
287
+ Only accurate and constant on Twitch emotes.<br>
288
+ For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
289
+
290
+
291
+
292
+ <dt class="tag-source">Source:</dt>
293
+ <dd class="tag-source"><ul class="dummy"><li>
294
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line26">line 26</a>
295
+ </li></ul></dd>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <dt class="tag-overrides">Overrides:</dt>
306
+ <dd class="tag-overrides"><ul class="dummy"><li>
307
+ <a href="Emote.html#channel">Emote#channel</a>
308
+ </li></ul></dd>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+ </dl>
333
+
334
+
335
+
336
+
337
+
338
+ <div class="description usertext">
339
+ <p>The channel this emote belongs to.<br>
340
+ Only accurate and constant on Twitch emotes.<br>
341
+ For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
342
+ </div>
343
+
344
+
345
+
346
+ <h5 class="h5-types">Type:</h5>
347
+ <ul>
348
+ <li>
349
+
350
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
351
+
352
+
353
+
354
+ </li>
355
+ </ul>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
365
+
366
+
367
+
368
+
369
+
370
+ <dl class="details">
371
+
372
+ <dt class="tag-description">Description:</dt>
373
+ <dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
374
+
375
+
376
+
377
+ <dt class="tag-source">Source:</dt>
378
+ <dd class="tag-source"><ul class="dummy"><li>
379
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line48">line 48</a>
380
+ </li></ul></dd>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <dt class="tag-overrides">Overrides:</dt>
391
+ <dd class="tag-overrides"><ul class="dummy"><li>
392
+ <a href="Emote.html#code">Emote#code</a>
393
+ </li></ul></dd>
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+ </dl>
418
+
419
+
420
+
421
+
422
+
423
+ <div class="description usertext">
424
+ <p>The code or name of the emote.</p>
425
+ </div>
426
+
427
+
428
+
429
+ <h5 class="h5-types">Type:</h5>
430
+ <ul>
431
+ <li>
432
+
433
+ <span class="param-type">string</span>
434
+
435
+
436
+
437
+ </li>
438
+ </ul>
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+ <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
448
+
449
+
450
+
451
+
452
+
453
+ <dl class="details">
454
+
455
+ <dt class="tag-description">Description:</dt>
456
+ <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
457
+
458
+
459
+
460
+ <dt class="tag-source">Source:</dt>
461
+ <dd class="tag-source"><ul class="dummy"><li>
462
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line18">line 18</a>
463
+ </li></ul></dd>
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+ <dt class="tag-overrides">Overrides:</dt>
474
+ <dd class="tag-overrides"><ul class="dummy"><li>
475
+ <a href="Emote.html#fetcher">Emote#fetcher</a>
476
+ </li></ul></dd>
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+ </dl>
501
+
502
+
503
+
504
+
505
+
506
+ <div class="description usertext">
507
+ <p>The emote fetcher.</p>
508
+ </div>
509
+
510
+
511
+
512
+ <h5 class="h5-types">Type:</h5>
513
+ <ul>
514
+ <li>
515
+
516
+ <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
517
+
518
+
519
+
520
+ </li>
521
+ </ul>
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+ <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
531
+
532
+
533
+
534
+
535
+
536
+ <dl class="details">
537
+
538
+ <dt class="tag-description">Description:</dt>
539
+ <dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
540
+
541
+
542
+
543
+ <dt class="tag-source">Source:</dt>
544
+ <dd class="tag-source"><ul class="dummy"><li>
545
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line32">line 32</a>
546
+ </li></ul></dd>
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+ <dt class="tag-overrides">Overrides:</dt>
557
+ <dd class="tag-overrides"><ul class="dummy"><li>
558
+ <a href="Emote.html#id">Emote#id</a>
559
+ </li></ul></dd>
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+ </dl>
584
+
585
+
586
+
587
+
588
+
589
+ <div class="description usertext">
590
+ <p>The ID of this emote.</p>
591
+ </div>
592
+
593
+
594
+
595
+ <h5 class="h5-types">Type:</h5>
596
+ <ul>
597
+ <li>
598
+
599
+ <span class="param-type">string</span>
600
+
601
+
602
+
603
+ </li>
604
+ </ul>
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+ <h4 class="name" id="imageType"><span class="type-signature"></span>imageType<span class="type-signature"> :string</span></h4>
614
+
615
+
616
+
617
+
618
+
619
+ <dl class="details">
620
+
621
+ <dt class="tag-description">Description:</dt>
622
+ <dd class="tag-description"><ul class="dummy"><li><p>The image type of the emote.</p></li></ul></dd>
623
+
624
+
625
+
626
+ <dt class="tag-source">Source:</dt>
627
+ <dd class="tag-source"><ul class="dummy"><li>
628
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line41">line 41</a>
629
+ </li></ul></dd>
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
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 image type of the 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="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>
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 channel of this emote's creator.<br>
701
+ Not guaranteed to contain the emote, or be cached.</p></li></ul></dd>
702
+
703
+
704
+
705
+ <dt class="tag-source">Source:</dt>
706
+ <dd class="tag-source"><ul class="dummy"><li>
707
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line23">line 23</a>
708
+ </li></ul></dd>
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
+
740
+ </dl>
741
+
742
+
743
+
744
+
745
+
746
+ <div class="description usertext">
747
+ <p>The channel of this emote's creator.<br>
748
+ Not guaranteed to contain the emote, or be cached.</p>
749
+ </div>
750
+
751
+
752
+
753
+ <h5 class="h5-types">Type:</h5>
754
+ <ul>
755
+ <li>
756
+
757
+ <span class="param-type"><a href="Channel.html">Channel</a></span>
758
+
759
+
760
+
761
+ </li>
762
+ </ul>
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+ <h4 class="name" id="ownerName"><span class="type-signature type-signature-nullable">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
772
+
773
+
774
+
775
+
776
+
777
+ <dl class="details">
778
+
779
+ <dt class="tag-description">Description:</dt>
780
+ <dd class="tag-description"><ul class="dummy"><li><p>The name of the emote creator's channel.<br>
781
+ Will be null for global or channel emotes.</p></li></ul></dd>
782
+
783
+
784
+
785
+ <dt class="tag-source">Source:</dt>
786
+ <dd class="tag-source"><ul class="dummy"><li>
787
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line35">line 35</a>
788
+ </li></ul></dd>
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
+
819
+
820
+ </dl>
821
+
822
+
823
+
824
+
825
+
826
+ <div class="description usertext">
827
+ <p>The name of the emote creator's channel.<br>
828
+ Will be null for global or channel emotes.</p>
829
+ </div>
830
+
831
+
832
+
833
+ <h5 class="h5-types">Type:</h5>
834
+ <ul>
835
+ <li>
836
+
837
+ <span class="param-type">string</span>
838
+
839
+
840
+
841
+ </li>
842
+ </ul>
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+
851
+ <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
852
+
853
+
854
+
855
+
856
+
857
+ <dl class="details">
858
+
859
+ <dt class="tag-description">Description:</dt>
860
+ <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
861
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
862
+
863
+
864
+
865
+ <dt class="tag-source">Source:</dt>
866
+ <dd class="tag-source"><ul class="dummy"><li>
867
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line39">line 39</a>
868
+ </li></ul></dd>
869
+
870
+
871
+
872
+
873
+
874
+
875
+
876
+
877
+
878
+ <dt class="tag-overrides">Overrides:</dt>
879
+ <dd class="tag-overrides"><ul class="dummy"><li>
880
+ <a href="Emote.html#type">Emote#type</a>
881
+ </li></ul></dd>
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+ </dl>
906
+
907
+
908
+
909
+
910
+
911
+ <div class="description usertext">
912
+ <p>The type of this emote.<br>
913
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
914
+ </div>
915
+
916
+
917
+
918
+ <h5 class="h5-types">Type:</h5>
919
+ <ul>
920
+ <li>
921
+
922
+ <span class="param-type">string</span>
923
+
924
+
925
+
926
+ </li>
927
+ </ul>
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+ <h3 class="subsection-title">Methods</h3>
939
+
940
+
941
+
942
+
943
+
944
+
945
+ <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
946
+
947
+
948
+
949
+
950
+
951
+
952
+ <dl class="details">
953
+
954
+ <dt class="tag-description">Description:</dt>
955
+ <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
956
+
957
+
958
+
959
+ <dt class="tag-source">Source:</dt>
960
+ <dd class="tag-source"><ul class="dummy"><li>
961
+ <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line49">line 49</a>
962
+ </li></ul></dd>
963
+
964
+
965
+
966
+
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+
975
+
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+ </dl>
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+ <h5 class="h5-parameters">Parameters:</h5>
1009
+
1010
+
1011
+ <table class="params">
1012
+ <thead>
1013
+ <tr>
1014
+
1015
+ <th>Name</th>
1016
+
1017
+
1018
+ <th>Type</th>
1019
+
1020
+
1021
+
1022
+
1023
+ <th>Default</th>
1024
+
1025
+
1026
+ <th class="last">Description</th>
1027
+ </tr>
1028
+ </thead>
1029
+
1030
+ <tbody>
1031
+
1032
+
1033
+ <tr>
1034
+
1035
+ <td class="name"><code>size</code></td>
1036
+
1037
+
1038
+ <td class="type">
1039
+
1040
+
1041
+ <span class="param-type">number</span>
1042
+
1043
+
1044
+
1045
+
1046
+ </td>
1047
+
1048
+
1049
+
1050
+
1051
+ <td class="default">
1052
+
1053
+ <code>0</code>
1054
+
1055
+ </td>
1056
+
1057
+
1058
+ <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
1059
+ </tr>
1060
+
1061
+
1062
+ </tbody>
1063
+ </table>
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+ <h5 class="h5-returns">Returns:</h5>
1081
+
1082
+
1083
+
1084
+
1085
+ <dl class="param-type">
1086
+ <dt>
1087
+ Type
1088
+ </dt>
1089
+ <dd>
1090
+
1091
+ <span class="param-type">string</span>
1092
+
1093
+
1094
+
1095
+ </dd>
1096
+ </dl>
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1108
+
1109
+
1110
+
1111
+
1112
+
1113
+
1114
+ <dl class="details">
1115
+
1116
+ <dt class="tag-description">Description:</dt>
1117
+ <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
1118
+ Will give the emote's name.</p></li></ul></dd>
1119
+
1120
+
1121
+
1122
+ <dt class="tag-source">Source:</dt>
1123
+ <dd class="tag-source"><ul class="dummy"><li>
1124
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line60">line 60</a>
1125
+ </li></ul></dd>
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+ <dt class="tag-overrides">Overrides:</dt>
1136
+ <dd class="tag-overrides"><ul class="dummy"><li>
1137
+ <a href="Emote.html#toString">Emote#toString</a>
1138
+ </li></ul></dd>
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+ </dl>
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+ <h5 class="h5-returns">Returns:</h5>
1191
+
1192
+
1193
+
1194
+
1195
+ <dl class="param-type">
1196
+ <dt>
1197
+ Type
1198
+ </dt>
1199
+ <dd>
1200
+
1201
+ <span class="param-type">string</span>
1202
+
1203
+
1204
+
1205
+ </dd>
1206
+ </dl>
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+ </article>
1219
+
1220
+ </section>
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+ </div>
1228
+
1229
+ <br class="clear">
1230
+
1231
+ <footer>
1232
+ 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.
1233
+ </footer>
1234
+
1235
+ <script>prettyPrint();</script>
1236
+ <script src="scripts/polyfill.js"></script>
1237
+ <script src="scripts/linenumber.js"></script>
1238
+
1239
+
1240
+
1241
+ </body>
1192
1242
  </html>