@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
- FFZEmote
51
+
52
+ FFZEmote
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>An FFZ 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>An FFZ 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,18 @@ 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, nullable) </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, nullable">(readonly, nullable) </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.<br>
701
+ Not guaranteed to contain the emote, or be cached.</p></li></ul></dd>
702
+
665
703
 
666
704
 
667
705
  <dt class="tag-source">Source:</dt>
@@ -712,13 +750,14 @@ Not guaranteed to contain the emote, or be cached.</p>
712
750
 
713
751
 
714
752
 
715
- <h5>Type:</h5>
753
+ <h5 class="h5-types">Type:</h5>
716
754
  <ul>
717
755
  <li>
718
756
 
719
757
  <span class="param-type"><a href="Channel.html">Channel</a></span>
720
758
 
721
759
 
760
+
722
761
  </li>
723
762
  </ul>
724
763
 
@@ -736,6 +775,10 @@ Not guaranteed to contain the emote, or be cached.</p>
736
775
 
737
776
 
738
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.</p></li></ul></dd>
781
+
739
782
 
740
783
 
741
784
  <dt class="tag-source">Source:</dt>
@@ -785,13 +828,14 @@ Not guaranteed to contain the emote, or be cached.</p>
785
828
 
786
829
 
787
830
 
788
- <h5>Type:</h5>
831
+ <h5 class="h5-types">Type:</h5>
789
832
  <ul>
790
833
  <li>
791
834
 
792
835
  <span class="param-type">string</span>
793
836
 
794
837
 
838
+
795
839
  </li>
796
840
  </ul>
797
841
 
@@ -809,6 +853,10 @@ Not guaranteed to contain the emote, or be cached.</p>
809
853
 
810
854
 
811
855
  <dl class="details">
856
+
857
+ <dt class="tag-description">Description:</dt>
858
+ <dd class="tag-description"><ul class="dummy"><li><p>Available image sizes.</p></li></ul></dd>
859
+
812
860
 
813
861
 
814
862
  <dt class="tag-source">Source:</dt>
@@ -858,13 +906,14 @@ Not guaranteed to contain the emote, or be cached.</p>
858
906
 
859
907
 
860
908
 
861
- <h5>Type:</h5>
909
+ <h5 class="h5-types">Type:</h5>
862
910
  <ul>
863
911
  <li>
864
912
 
865
913
  <span class="param-type">Array.&lt;string></span>
866
914
 
867
915
 
916
+
868
917
  </li>
869
918
  </ul>
870
919
 
@@ -882,6 +931,11 @@ Not guaranteed to contain the emote, or be cached.</p>
882
931
 
883
932
 
884
933
  <dl class="details">
934
+
935
+ <dt class="tag-description">Description:</dt>
936
+ <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
937
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
938
+
885
939
 
886
940
 
887
941
  <dt class="tag-source">Source:</dt>
@@ -932,18 +986,19 @@ Not guaranteed to contain the emote, or be cached.</p>
932
986
 
933
987
  <div class="description usertext">
934
988
  <p>The type of this emote.<br>
935
- Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
989
+ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
936
990
  </div>
937
991
 
938
992
 
939
993
 
940
- <h5>Type:</h5>
994
+ <h5 class="h5-types">Type:</h5>
941
995
  <ul>
942
996
  <li>
943
997
 
944
998
  <span class="param-type">string</span>
945
999
 
946
1000
 
1001
+
947
1002
  </li>
948
1003
  </ul>
949
1004
 
@@ -971,6 +1026,10 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
971
1026
 
972
1027
 
973
1028
  <dl class="details">
1029
+
1030
+ <dt class="tag-description">Description:</dt>
1031
+ <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
1032
+
974
1033
 
975
1034
 
976
1035
  <dt class="tag-source">Source:</dt>
@@ -1014,11 +1073,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1014
1073
 
1015
1074
 
1016
1075
 
1017
- <div class="description usertext">
1018
- <p>Gets the image link of the emote.</p>
1019
- </div>
1020
-
1021
-
1022
1076
 
1023
1077
 
1024
1078
 
@@ -1027,8 +1081,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1027
1081
 
1028
1082
 
1029
1083
 
1030
-
1031
- <h5>Parameters:</h5>
1084
+ <h5 class="h5-parameters">Parameters:</h5>
1032
1085
 
1033
1086
 
1034
1087
  <table class="params">
@@ -1064,6 +1117,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1064
1117
  <span class="param-type">number</span>
1065
1118
 
1066
1119
 
1120
+
1067
1121
 
1068
1122
  </td>
1069
1123
 
@@ -1099,7 +1153,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1099
1153
 
1100
1154
 
1101
1155
 
1102
- <h5>Returns:</h5>
1156
+ <h5 class="h5-returns">Returns:</h5>
1103
1157
 
1104
1158
 
1105
1159
 
@@ -1113,6 +1167,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1113
1167
  <span class="param-type">string</span>
1114
1168
 
1115
1169
 
1170
+
1116
1171
  </dd>
1117
1172
  </dl>
1118
1173
 
@@ -1133,6 +1188,11 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1133
1188
 
1134
1189
 
1135
1190
  <dl class="details">
1191
+
1192
+ <dt class="tag-description">Description:</dt>
1193
+ <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
1194
+ Will give the emote's name.</p></li></ul></dd>
1195
+
1136
1196
 
1137
1197
 
1138
1198
  <dt class="tag-source">Source:</dt>
@@ -1181,11 +1241,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
1181
1241
 
1182
1242
 
1183
1243
 
1184
- <div class="description usertext">
1185
- <p>Override for <code>toString</code>.<br>
1186
- Will give the emote's name.</p>
1187
- </div>
1188
-
1189
1244
 
1190
1245
 
1191
1246
 
@@ -1208,9 +1263,7 @@ Will give the emote's name.</p>
1208
1263
 
1209
1264
 
1210
1265
 
1211
-
1212
-
1213
- <h5>Returns:</h5>
1266
+ <h5 class="h5-returns">Returns:</h5>
1214
1267
 
1215
1268
 
1216
1269
 
@@ -1224,6 +1277,7 @@ Will give the emote's name.</p>
1224
1277
  <span class="param-type">string</span>
1225
1278
 
1226
1279
 
1280
+
1227
1281
  </dd>
1228
1282
  </dl>
1229
1283
 
@@ -1251,7 +1305,7 @@ Will give the emote's name.</p>
1251
1305
  <br class="clear">
1252
1306
 
1253
1307
  <footer>
1254
- 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.
1308
+ 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.
1255
1309
  </footer>
1256
1310
 
1257
1311
  <script>prettyPrint();</script>