@mkody/twitch-emoticons 2.5.0 → 2.6.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.
@@ -14,6 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
+
17
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
19
  </head>
19
20
  <body>
@@ -27,7 +28,9 @@
27
28
 
28
29
  <nav >
29
30
 
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
+
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
+
31
34
  </nav>
32
35
 
33
36
  <div id="main">
@@ -45,7 +48,9 @@
45
48
  <header>
46
49
 
47
50
  <h2>
48
- TwitchEmote
51
+
52
+ TwitchEmote
53
+
49
54
  </h2>
50
55
 
51
56
 
@@ -67,6 +72,10 @@
67
72
 
68
73
 
69
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
+
70
79
 
71
80
 
72
81
  <dt class="tag-source">Source:</dt>
@@ -110,12 +119,6 @@
110
119
 
111
120
 
112
121
 
113
- <div class="description usertext">
114
- <p>A Twitch emote.</p>
115
- </div>
116
-
117
-
118
-
119
122
 
120
123
 
121
124
 
@@ -124,7 +127,7 @@
124
127
 
125
128
 
126
129
 
127
- <h5>Parameters:</h5>
130
+ <h5 class="h5-parameters">Parameters:</h5>
128
131
 
129
132
 
130
133
  <table class="params">
@@ -158,6 +161,7 @@
158
161
  <span class="param-type"><a href="Channel.html">Channel</a></span>
159
162
 
160
163
 
164
+
161
165
 
162
166
  </td>
163
167
 
@@ -181,6 +185,7 @@
181
185
  <span class="param-type">string</span>
182
186
 
183
187
 
188
+
184
189
 
185
190
  </td>
186
191
 
@@ -204,6 +209,7 @@
204
209
  <span class="param-type">data</span>
205
210
 
206
211
 
212
+
207
213
 
208
214
  </td>
209
215
 
@@ -275,6 +281,12 @@
275
281
 
276
282
 
277
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
+
278
290
 
279
291
 
280
292
  <dt class="tag-source">Source:</dt>
@@ -331,13 +343,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
331
343
 
332
344
 
333
345
 
334
- <h5>Type:</h5>
346
+ <h5 class="h5-types">Type:</h5>
335
347
  <ul>
336
348
  <li>
337
349
 
338
350
  <span class="param-type"><a href="Channel.html">Channel</a></span>
339
351
 
340
352
 
353
+
341
354
  </li>
342
355
  </ul>
343
356
 
@@ -355,6 +368,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
355
368
 
356
369
 
357
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
+
358
375
 
359
376
 
360
377
  <dt class="tag-source">Source:</dt>
@@ -409,13 +426,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
409
426
 
410
427
 
411
428
 
412
- <h5>Type:</h5>
429
+ <h5 class="h5-types">Type:</h5>
413
430
  <ul>
414
431
  <li>
415
432
 
416
433
  <span class="param-type">string</span>
417
434
 
418
435
 
436
+
419
437
  </li>
420
438
  </ul>
421
439
 
@@ -433,6 +451,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
433
451
 
434
452
 
435
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
+
436
458
 
437
459
 
438
460
  <dt class="tag-source">Source:</dt>
@@ -487,13 +509,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
487
509
 
488
510
 
489
511
 
490
- <h5>Type:</h5>
512
+ <h5 class="h5-types">Type:</h5>
491
513
  <ul>
492
514
  <li>
493
515
 
494
516
  <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
495
517
 
496
518
 
519
+
497
520
  </li>
498
521
  </ul>
499
522
 
@@ -511,6 +534,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
511
534
 
512
535
 
513
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
+
514
541
 
515
542
 
516
543
  <dt class="tag-source">Source:</dt>
@@ -565,13 +592,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
565
592
 
566
593
 
567
594
 
568
- <h5>Type:</h5>
595
+ <h5 class="h5-types">Type:</h5>
569
596
  <ul>
570
597
  <li>
571
598
 
572
599
  <span class="param-type">string</span>
573
600
 
574
601
 
602
+
575
603
  </li>
576
604
  </ul>
577
605
 
@@ -589,6 +617,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
589
617
 
590
618
 
591
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
+
592
624
 
593
625
 
594
626
  <dt class="tag-source">Source:</dt>
@@ -638,13 +670,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
638
670
 
639
671
 
640
672
 
641
- <h5>Type:</h5>
673
+ <h5 class="h5-types">Type:</h5>
642
674
  <ul>
643
675
  <li>
644
676
 
645
677
  <span class="param-type">string</span>
646
678
 
647
679
 
680
+
648
681
  </li>
649
682
  </ul>
650
683
 
@@ -655,13 +688,17 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
655
688
 
656
689
 
657
690
 
658
- <h4 class="name" id="owner"><span class="type-signature">(readonly) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
691
+ <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>
659
692
 
660
693
 
661
694
 
662
695
 
663
696
 
664
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.</p></li></ul></dd>
701
+
665
702
 
666
703
 
667
704
  <dt class="tag-source">Source:</dt>
@@ -711,13 +748,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
711
748
 
712
749
 
713
750
 
714
- <h5>Type:</h5>
751
+ <h5 class="h5-types">Type:</h5>
715
752
  <ul>
716
753
  <li>
717
754
 
718
755
  <span class="param-type"><a href="Channel.html">Channel</a></span>
719
756
 
720
757
 
758
+
721
759
  </li>
722
760
  </ul>
723
761
 
@@ -728,13 +766,17 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
728
766
 
729
767
 
730
768
 
731
- <h4 class="name" id="set"><span class="type-signature">(nullable) </span>set<span class="type-signature"> :string</span></h4>
769
+ <h4 class="name" id="set"><span class="type-signature type-signature-nullable">(nullable) </span>set<span class="type-signature"> :string</span></h4>
732
770
 
733
771
 
734
772
 
735
773
 
736
774
 
737
775
  <dl class="details">
776
+
777
+ <dt class="tag-description">Description:</dt>
778
+ <dd class="tag-description"><ul class="dummy"><li><p>The set ID of the emote.</p></li></ul></dd>
779
+
738
780
 
739
781
 
740
782
  <dt class="tag-source">Source:</dt>
@@ -784,13 +826,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
784
826
 
785
827
 
786
828
 
787
- <h5>Type:</h5>
829
+ <h5 class="h5-types">Type:</h5>
788
830
  <ul>
789
831
  <li>
790
832
 
791
833
  <span class="param-type">string</span>
792
834
 
793
835
 
836
+
794
837
  </li>
795
838
  </ul>
796
839
 
@@ -808,6 +851,11 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
808
851
 
809
852
 
810
853
  <dl class="details">
854
+
855
+ <dt class="tag-description">Description:</dt>
856
+ <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
857
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
858
+
811
859
 
812
860
 
813
861
  <dt class="tag-source">Source:</dt>
@@ -858,18 +906,19 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
858
906
 
859
907
  <div class="description usertext">
860
908
  <p>The type of this emote.<br>
861
- Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
909
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
862
910
  </div>
863
911
 
864
912
 
865
913
 
866
- <h5>Type:</h5>
914
+ <h5 class="h5-types">Type:</h5>
867
915
  <ul>
868
916
  <li>
869
917
 
870
918
  <span class="param-type">string</span>
871
919
 
872
920
 
921
+
873
922
  </li>
874
923
  </ul>
875
924
 
@@ -897,6 +946,10 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
897
946
 
898
947
 
899
948
  <dl class="details">
949
+
950
+ <dt class="tag-description">Description:</dt>
951
+ <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
952
+
900
953
 
901
954
 
902
955
  <dt class="tag-source">Source:</dt>
@@ -940,12 +993,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
940
993
 
941
994
 
942
995
 
943
- <div class="description usertext">
944
- <p>Gets the image link of the emote.</p>
945
- </div>
946
-
947
-
948
-
949
996
 
950
997
 
951
998
 
@@ -954,7 +1001,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
954
1001
 
955
1002
 
956
1003
 
957
- <h5>Parameters:</h5>
1004
+ <h5 class="h5-parameters">Parameters:</h5>
958
1005
 
959
1006
 
960
1007
  <table class="params">
@@ -990,6 +1037,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
990
1037
  <span class="param-type">number</span>
991
1038
 
992
1039
 
1040
+
993
1041
 
994
1042
  </td>
995
1043
 
@@ -1025,7 +1073,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1025
1073
 
1026
1074
 
1027
1075
 
1028
- <h5>Returns:</h5>
1076
+ <h5 class="h5-returns">Returns:</h5>
1029
1077
 
1030
1078
 
1031
1079
 
@@ -1039,6 +1087,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1039
1087
  <span class="param-type">string</span>
1040
1088
 
1041
1089
 
1090
+
1042
1091
  </dd>
1043
1092
  </dl>
1044
1093
 
@@ -1059,6 +1108,11 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1059
1108
 
1060
1109
 
1061
1110
  <dl class="details">
1111
+
1112
+ <dt class="tag-description">Description:</dt>
1113
+ <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
1114
+ Will give the emote's name.</p></li></ul></dd>
1115
+
1062
1116
 
1063
1117
 
1064
1118
  <dt class="tag-source">Source:</dt>
@@ -1107,11 +1161,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1107
1161
 
1108
1162
 
1109
1163
 
1110
- <div class="description usertext">
1111
- <p>Override for <code>toString</code>.<br>
1112
- Will give the emote's name.</p>
1113
- </div>
1114
-
1115
1164
 
1116
1165
 
1117
1166
 
@@ -1134,9 +1183,7 @@ Will give the emote's name.</p>
1134
1183
 
1135
1184
 
1136
1185
 
1137
-
1138
-
1139
- <h5>Returns:</h5>
1186
+ <h5 class="h5-returns">Returns:</h5>
1140
1187
 
1141
1188
 
1142
1189
 
@@ -1150,6 +1197,7 @@ Will give the emote's name.</p>
1150
1197
  <span class="param-type">string</span>
1151
1198
 
1152
1199
 
1200
+
1153
1201
  </dd>
1154
1202
  </dl>
1155
1203
 
@@ -1177,7 +1225,7 @@ Will give the emote's name.</p>
1177
1225
  <br class="clear">
1178
1226
 
1179
1227
  <footer>
1180
- 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.
1228
+ 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.
1181
1229
  </footer>
1182
1230
 
1183
1231
  <script>prettyPrint();</script>