@mkody/twitch-emoticons 2.9.6 → 3.0.0-beta.2

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 (80) hide show
  1. package/README.md +530 -169
  2. package/dist/TwitchEmoticons.cjs +950 -0
  3. package/dist/TwitchEmoticons.esm.min.js +7 -0
  4. package/dist/TwitchEmoticons.esm.min.js.map +7 -0
  5. package/dist/TwitchEmoticons.min.js +2 -20
  6. package/dist/TwitchEmoticons.min.js.map +4 -4
  7. package/package.json +99 -72
  8. package/src/index.js +38 -12
  9. package/src/struct/BTTVEmote.js +72 -74
  10. package/src/struct/Channel.js +48 -48
  11. package/src/struct/Emote.js +71 -71
  12. package/src/struct/EmoteFetcher.js +358 -322
  13. package/src/struct/EmoteParser.js +95 -84
  14. package/src/struct/EmoteTypeMapper.js +9 -9
  15. package/src/struct/FFZEmote.js +91 -93
  16. package/src/struct/SevenTVEmote.js +88 -90
  17. package/src/struct/TwitchEmote.js +72 -71
  18. package/src/util/Collection.js +69 -55
  19. package/src/util/Constants.js +30 -30
  20. package/typings/index.d.cts +254 -0
  21. package/typings/index.d.ts +216 -99
  22. package/.jsdoc.json +0 -46
  23. package/.nvmrc +0 -1
  24. package/docs/BTTVEmote.html +0 -1532
  25. package/docs/Channel.html +0 -824
  26. package/docs/Collection.html +0 -798
  27. package/docs/Emote.html +0 -832
  28. package/docs/EmoteFetcher.html +0 -3741
  29. package/docs/EmoteParser.html +0 -1187
  30. package/docs/FFZEmote.html +0 -1686
  31. package/docs/SevenTVEmote.html +0 -1596
  32. package/docs/TwitchEmote.html +0 -1528
  33. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  34. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  35. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  36. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  37. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  38. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  39. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  40. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  42. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
  43. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  44. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  45. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  46. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  47. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
  48. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  49. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  50. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  51. package/docs/index.html +0 -233
  52. package/docs/scripts/collapse.js +0 -39
  53. package/docs/scripts/commonNav.js +0 -28
  54. package/docs/scripts/linenumber.js +0 -25
  55. package/docs/scripts/nav.js +0 -12
  56. package/docs/scripts/polyfill.js +0 -4
  57. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  58. package/docs/scripts/prettify/lang-css.js +0 -2
  59. package/docs/scripts/prettify/prettify.js +0 -28
  60. package/docs/scripts/search.js +0 -99
  61. package/docs/struct_BTTVEmote.js.html +0 -162
  62. package/docs/struct_Channel.js.html +0 -132
  63. package/docs/struct_Emote.js.html +0 -159
  64. package/docs/struct_EmoteFetcher.js.html +0 -429
  65. package/docs/struct_EmoteParser.js.html +0 -172
  66. package/docs/struct_FFZEmote.js.html +0 -185
  67. package/docs/struct_SevenTVEmote.js.html +0 -180
  68. package/docs/struct_TwitchEmote.js.html +0 -159
  69. package/docs/styles/jsdoc.css +0 -776
  70. package/docs/styles/prettify.css +0 -80
  71. package/docs/util_Collection.js.html +0 -151
  72. package/eslint.config.mjs +0 -215
  73. package/jest.config.js +0 -198
  74. package/test/BTTV.test.js +0 -48
  75. package/test/FFZ.test.js +0 -71
  76. package/test/SevenTV.test.js +0 -71
  77. package/test/ToFromObject.test.js +0 -156
  78. package/test/Twitch.test.js +0 -64
  79. package/test/__snapshots__/ToFromObject.test.js.snap +0 -121
  80. package/test/other.test.js +0 -72
@@ -1,1528 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>TwitchEmote - 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><h2><a href="https://github.com/mkody/twitch-emoticons" target="_blank" class="menu-item" id="github_link" >GitHub</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#.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="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toObject">toObject</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</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#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#.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#.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#.fromObject">fromObject</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li></ul>
33
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">TwitchEmote</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
-
48
- <header>
49
-
50
- <h2>
51
-
52
- TwitchEmote
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="TwitchEmote"><span class="type-signature"></span>new TwitchEmote<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 Twitch 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_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.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="owner"><span class="type-signature type-signature-readonly">(readonly) </span>owner<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 of this emote's creator.</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_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line22">line 22</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>The channel of this emote's creator.</p>
333
- </div>
334
-
335
-
336
-
337
- <h5 class="h5-types">Type:</h5>
338
- <ul>
339
- <li>
340
-
341
- <span class="param-type"><a href="Channel.html">Channel</a></span>
342
-
343
-
344
-
345
- </li>
346
- </ul>
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
- <h4 class="name" id="set"><span class="type-signature type-signature-nullable">(nullable) </span>set<span class="type-signature"> :string</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 set ID of the emote.</p></li></ul></dd>
365
-
366
-
367
-
368
- <dt class="tag-source">Source:</dt>
369
- <dd class="tag-source"><ul class="dummy"><li>
370
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line33">line 33</a>
371
- </li></ul></dd>
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
- </dl>
404
-
405
-
406
-
407
-
408
-
409
- <div class="description usertext">
410
- <p>The set ID of the emote.</p>
411
- </div>
412
-
413
-
414
-
415
- <h5 class="h5-types">Type:</h5>
416
- <ul>
417
- <li>
418
-
419
- <span class="param-type">string</span>
420
-
421
-
422
-
423
- </li>
424
- </ul>
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
- <h4 class="name" id="animated"><span class="type-signature"></span>animated<span class="type-signature"> :boolean</span></h4>
434
-
435
-
436
-
437
-
438
-
439
- <dl class="details">
440
-
441
- <dt class="tag-description">Description:</dt>
442
- <dd class="tag-description"><ul class="dummy"><li><p>If emote is animated.</p></li></ul></dd>
443
-
444
-
445
-
446
- <dt class="tag-source">Source:</dt>
447
- <dd class="tag-source"><ul class="dummy"><li>
448
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line39">line 39</a>
449
- </li></ul></dd>
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
- </dl>
482
-
483
-
484
-
485
-
486
-
487
- <div class="description usertext">
488
- <p>If emote is animated.</p>
489
- </div>
490
-
491
-
492
-
493
- <h5 class="h5-types">Type:</h5>
494
- <ul>
495
- <li>
496
-
497
- <span class="param-type">boolean</span>
498
-
499
-
500
-
501
- </li>
502
- </ul>
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
- <h4 class="name" id="imageType"><span class="type-signature"></span>imageType<span class="type-signature"> :string</span></h4>
512
-
513
-
514
-
515
-
516
-
517
- <dl class="details">
518
-
519
- <dt class="tag-description">Description:</dt>
520
- <dd class="tag-description"><ul class="dummy"><li><p>The image type of the emote.</p></li></ul></dd>
521
-
522
-
523
-
524
- <dt class="tag-source">Source:</dt>
525
- <dd class="tag-source"><ul class="dummy"><li>
526
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line45">line 45</a>
527
- </li></ul></dd>
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
- </dl>
560
-
561
-
562
-
563
-
564
-
565
- <div class="description usertext">
566
- <p>The image type of the emote.</p>
567
- </div>
568
-
569
-
570
-
571
- <h5 class="h5-types">Type:</h5>
572
- <ul>
573
- <li>
574
-
575
- <span class="param-type">string</span>
576
-
577
-
578
-
579
- </li>
580
- </ul>
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
- <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
590
-
591
-
592
-
593
-
594
-
595
- <dl class="details">
596
-
597
- <dt class="tag-description">Description:</dt>
598
- <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
599
-
600
-
601
-
602
- <dt class="tag-source">Source:</dt>
603
- <dd class="tag-source"><ul class="dummy"><li>
604
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line19">line 19</a>
605
- </li></ul></dd>
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
- <dt class="tag-overrides">Overrides:</dt>
616
- <dd class="tag-overrides"><ul class="dummy"><li>
617
- <a href="Emote.html#fetcher">Emote#fetcher</a>
618
- </li></ul></dd>
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
- </dl>
643
-
644
-
645
-
646
-
647
-
648
- <div class="description usertext">
649
- <p>The emote fetcher.</p>
650
- </div>
651
-
652
-
653
-
654
- <h5 class="h5-types">Type:</h5>
655
- <ul>
656
- <li>
657
-
658
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
659
-
660
-
661
-
662
- </li>
663
- </ul>
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
- <h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
673
-
674
-
675
-
676
-
677
-
678
- <dl class="details">
679
-
680
- <dt class="tag-description">Description:</dt>
681
- <dd class="tag-description"><ul class="dummy"><li><p>The channel this emote belongs to.<br>
682
- Only accurate and constant on Twitch emotes.<br>
683
- For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
684
-
685
-
686
-
687
- <dt class="tag-source">Source:</dt>
688
- <dd class="tag-source"><ul class="dummy"><li>
689
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line27">line 27</a>
690
- </li></ul></dd>
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
- <dt class="tag-overrides">Overrides:</dt>
701
- <dd class="tag-overrides"><ul class="dummy"><li>
702
- <a href="Emote.html#channel">Emote#channel</a>
703
- </li></ul></dd>
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
-
714
-
715
-
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
-
726
-
727
- </dl>
728
-
729
-
730
-
731
-
732
-
733
- <div class="description usertext">
734
- <p>The channel this emote belongs to.<br>
735
- Only accurate and constant on Twitch emotes.<br>
736
- For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
737
- </div>
738
-
739
-
740
-
741
- <h5 class="h5-types">Type:</h5>
742
- <ul>
743
- <li>
744
-
745
- <span class="param-type"><a href="Channel.html">Channel</a></span>
746
-
747
-
748
-
749
- </li>
750
- </ul>
751
-
752
-
753
-
754
-
755
-
756
-
757
-
758
-
759
- <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
760
-
761
-
762
-
763
-
764
-
765
- <dl class="details">
766
-
767
- <dt class="tag-description">Description:</dt>
768
- <dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
769
-
770
-
771
-
772
- <dt class="tag-source">Source:</dt>
773
- <dd class="tag-source"><ul class="dummy"><li>
774
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line33">line 33</a>
775
- </li></ul></dd>
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
- <dt class="tag-overrides">Overrides:</dt>
786
- <dd class="tag-overrides"><ul class="dummy"><li>
787
- <a href="Emote.html#id">Emote#id</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
- </dl>
813
-
814
-
815
-
816
-
817
-
818
- <div class="description usertext">
819
- <p>The ID of this emote.</p>
820
- </div>
821
-
822
-
823
-
824
- <h5 class="h5-types">Type:</h5>
825
- <ul>
826
- <li>
827
-
828
- <span class="param-type">string</span>
829
-
830
-
831
-
832
- </li>
833
- </ul>
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
- <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
843
-
844
-
845
-
846
-
847
-
848
- <dl class="details">
849
-
850
- <dt class="tag-description">Description:</dt>
851
- <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
852
- Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
853
-
854
-
855
-
856
- <dt class="tag-source">Source:</dt>
857
- <dd class="tag-source"><ul class="dummy"><li>
858
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line40">line 40</a>
859
- </li></ul></dd>
860
-
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
-
869
- <dt class="tag-overrides">Overrides:</dt>
870
- <dd class="tag-overrides"><ul class="dummy"><li>
871
- <a href="Emote.html#type">Emote#type</a>
872
- </li></ul></dd>
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
-
894
-
895
-
896
- </dl>
897
-
898
-
899
-
900
-
901
-
902
- <div class="description usertext">
903
- <p>The type of this emote.<br>
904
- Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
905
- </div>
906
-
907
-
908
-
909
- <h5 class="h5-types">Type:</h5>
910
- <ul>
911
- <li>
912
-
913
- <span class="param-type">string</span>
914
-
915
-
916
-
917
- </li>
918
- </ul>
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
-
927
- <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
928
-
929
-
930
-
931
-
932
-
933
- <dl class="details">
934
-
935
- <dt class="tag-description">Description:</dt>
936
- <dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
937
-
938
-
939
-
940
- <dt class="tag-source">Source:</dt>
941
- <dd class="tag-source"><ul class="dummy"><li>
942
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line50">line 50</a>
943
- </li></ul></dd>
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
- <dt class="tag-overrides">Overrides:</dt>
954
- <dd class="tag-overrides"><ul class="dummy"><li>
955
- <a href="Emote.html#code">Emote#code</a>
956
- </li></ul></dd>
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
- </dl>
981
-
982
-
983
-
984
-
985
-
986
- <div class="description usertext">
987
- <p>The code or name of the emote.</p>
988
- </div>
989
-
990
-
991
-
992
- <h5 class="h5-types">Type:</h5>
993
- <ul>
994
- <li>
995
-
996
- <span class="param-type">string</span>
997
-
998
-
999
-
1000
- </li>
1001
- </ul>
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
-
1012
- <h3 class="subsection-title">Methods</h3>
1013
-
1014
-
1015
-
1016
-
1017
-
1018
-
1019
- <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
- <dl class="details">
1027
-
1028
- <dt class="tag-description">Description:</dt>
1029
- <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
1030
-
1031
-
1032
-
1033
- <dt class="tag-source">Source:</dt>
1034
- <dd class="tag-source"><ul class="dummy"><li>
1035
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line53">line 53</a>
1036
- </li></ul></dd>
1037
-
1038
-
1039
-
1040
-
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
- </dl>
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
-
1080
-
1081
-
1082
- <h5 class="h5-parameters">Parameters:</h5>
1083
-
1084
-
1085
- <table class="params">
1086
- <thead>
1087
- <tr>
1088
-
1089
- <th>Name</th>
1090
-
1091
-
1092
- <th>Type</th>
1093
-
1094
-
1095
-
1096
-
1097
- <th>Default</th>
1098
-
1099
-
1100
- <th class="last">Description</th>
1101
- </tr>
1102
- </thead>
1103
-
1104
- <tbody>
1105
-
1106
-
1107
- <tr>
1108
-
1109
- <td class="name"><code>size</code></td>
1110
-
1111
-
1112
- <td class="type">
1113
-
1114
-
1115
- <span class="param-type">number</span>
1116
-
1117
-
1118
-
1119
-
1120
- </td>
1121
-
1122
-
1123
-
1124
-
1125
- <td class="default">
1126
-
1127
- <code>0</code>
1128
-
1129
- </td>
1130
-
1131
-
1132
- <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
1133
- </tr>
1134
-
1135
-
1136
- </tbody>
1137
- </table>
1138
-
1139
-
1140
-
1141
-
1142
-
1143
-
1144
-
1145
-
1146
-
1147
-
1148
-
1149
-
1150
-
1151
-
1152
-
1153
-
1154
- <h5 class="h5-returns">Returns:</h5>
1155
-
1156
-
1157
-
1158
-
1159
- <dl class="param-type">
1160
- <dt>
1161
- Type
1162
- </dt>
1163
- <dd>
1164
-
1165
- <span class="param-type">string</span>
1166
-
1167
-
1168
-
1169
- </dd>
1170
- </dl>
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
-
1181
- <h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
1182
-
1183
-
1184
-
1185
-
1186
-
1187
-
1188
- <dl class="details">
1189
-
1190
- <dt class="tag-description">Description:</dt>
1191
- <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toObject</code>.<br>
1192
- Will result in an Object representation of a TwitchEmote</p></li></ul></dd>
1193
-
1194
-
1195
-
1196
- <dt class="tag-source">Source:</dt>
1197
- <dd class="tag-source"><ul class="dummy"><li>
1198
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line62">line 62</a>
1199
- </li></ul></dd>
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
- <dt class="tag-overrides">Overrides:</dt>
1210
- <dd class="tag-overrides"><ul class="dummy"><li>
1211
- <a href="Emote.html#toObject">Emote#toObject</a>
1212
- </li></ul></dd>
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
- </dl>
1237
-
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
- <h5 class="h5-returns">Returns:</h5>
1265
-
1266
-
1267
-
1268
-
1269
- <dl class="param-type">
1270
- <dt>
1271
- Type
1272
- </dt>
1273
- <dd>
1274
-
1275
- <span class="param-type">object</span>
1276
-
1277
-
1278
-
1279
- </dd>
1280
- </dl>
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
-
1288
-
1289
-
1290
-
1291
- <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="TwitchEmote.html">TwitchEmote</a>}</span></h4>
1292
-
1293
-
1294
-
1295
-
1296
-
1297
-
1298
- <dl class="details">
1299
-
1300
- <dt class="tag-description">Description:</dt>
1301
- <dd class="tag-description"><ul class="dummy"><li><p>Converts an emote Object into a TwitchEmote</p></li></ul></dd>
1302
-
1303
-
1304
-
1305
- <dt class="tag-source">Source:</dt>
1306
- <dd class="tag-source"><ul class="dummy"><li>
1307
- <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line76">line 76</a>
1308
- </li></ul></dd>
1309
-
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
-
1318
-
1319
-
1320
-
1321
-
1322
-
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
-
1333
-
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
- </dl>
1341
-
1342
-
1343
-
1344
-
1345
-
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
-
1354
- <h5 class="h5-parameters">Parameters:</h5>
1355
-
1356
-
1357
- <table class="params">
1358
- <thead>
1359
- <tr>
1360
-
1361
- <th>Name</th>
1362
-
1363
-
1364
- <th>Type</th>
1365
-
1366
-
1367
- <th>Attributes</th>
1368
-
1369
-
1370
-
1371
- <th>Default</th>
1372
-
1373
-
1374
- <th class="last">Description</th>
1375
- </tr>
1376
- </thead>
1377
-
1378
- <tbody>
1379
-
1380
-
1381
- <tr>
1382
-
1383
- <td class="name"><code>emoteObject</code></td>
1384
-
1385
-
1386
- <td class="type">
1387
-
1388
-
1389
- <span class="param-type">object</span>
1390
-
1391
-
1392
-
1393
-
1394
- </td>
1395
-
1396
-
1397
- <td class="attributes">
1398
-
1399
- &lt;optional><br>
1400
-
1401
-
1402
-
1403
-
1404
-
1405
- </td>
1406
-
1407
-
1408
-
1409
- <td class="default">
1410
-
1411
- </td>
1412
-
1413
-
1414
- <td class="description last"><p>Object representation of this emote</p></td>
1415
- </tr>
1416
-
1417
-
1418
-
1419
- <tr>
1420
-
1421
- <td class="name"><code>channel</code></td>
1422
-
1423
-
1424
- <td class="type">
1425
-
1426
-
1427
- <span class="param-type"><a href="Channel.html">Channel</a></span>
1428
-
1429
-
1430
-
1431
-
1432
- </td>
1433
-
1434
-
1435
- <td class="attributes">
1436
-
1437
- &lt;optional><br>
1438
-
1439
-
1440
-
1441
-
1442
-
1443
- </td>
1444
-
1445
-
1446
-
1447
- <td class="default">
1448
-
1449
- <code>null</code>
1450
-
1451
- </td>
1452
-
1453
-
1454
- <td class="description last"><p>Channel this emote belongs to.</p></td>
1455
- </tr>
1456
-
1457
-
1458
- </tbody>
1459
- </table>
1460
-
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
-
1476
- <h5 class="h5-returns">Returns:</h5>
1477
-
1478
-
1479
-
1480
-
1481
- <dl class="param-type">
1482
- <dt>
1483
- Type
1484
- </dt>
1485
- <dd>
1486
-
1487
- <span class="param-type"><a href="TwitchEmote.html">TwitchEmote</a></span>
1488
-
1489
-
1490
-
1491
- </dd>
1492
- </dl>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
- </article>
1505
-
1506
- </section>
1507
-
1508
-
1509
-
1510
-
1511
-
1512
-
1513
- </div>
1514
-
1515
- <br class="clear">
1516
-
1517
- <footer>
1518
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1519
- </footer>
1520
-
1521
- <script>prettyPrint();</script>
1522
- <script src="scripts/polyfill.js"></script>
1523
- <script src="scripts/linenumber.js"></script>
1524
-
1525
-
1526
-
1527
- </body>
1528
- </html>