@mkody/twitch-emoticons 2.8.7 → 2.8.9
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.
- package/SECURITY.md +2 -2
- package/dist/TwitchEmoticons.min.js +11 -11
- package/dist/TwitchEmoticons.min.js.map +4 -4
- package/docs/BTTVEmote.html +4 -4
- package/docs/Channel.html +1 -1
- package/docs/Collection.html +1 -1
- package/docs/Emote.html +3 -3
- package/docs/EmoteFetcher.html +17 -17
- package/docs/EmoteParser.html +4 -4
- package/docs/FFZEmote.html +4 -4
- package/docs/SevenTVEmote.html +4 -4
- package/docs/TwitchEmote.html +4 -4
- package/docs/index.html +2 -2
- package/docs/struct_BTTVEmote.js.html +4 -4
- package/docs/struct_Channel.js.html +1 -1
- package/docs/struct_Emote.js.html +2 -2
- package/docs/struct_EmoteFetcher.js.html +13 -13
- package/docs/struct_EmoteParser.js.html +3 -3
- package/docs/struct_FFZEmote.js.html +4 -4
- package/docs/struct_SevenTVEmote.js.html +4 -4
- package/docs/struct_TwitchEmote.js.html +4 -4
- package/docs/util_Collection.js.html +1 -1
- package/eslint.config.mjs +215 -0
- package/package.json +12 -9
- package/src/struct/BTTVEmote.js +3 -3
- package/src/struct/Emote.js +1 -1
- package/src/struct/EmoteFetcher.js +12 -12
- package/src/struct/EmoteParser.js +2 -2
- package/src/struct/FFZEmote.js +3 -3
- package/src/struct/SevenTVEmote.js +3 -3
- package/src/struct/TwitchEmote.js +3 -3
- package/test/SevenTV.test.js +4 -4
- package/test/__snapshots__/ToFromObject.test.js.snap +2 -2
- package/.eslintrc.json +0 -143
package/docs/BTTVEmote.html
CHANGED
|
@@ -1182,7 +1182,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
|
1182
1182
|
|
|
1183
1183
|
|
|
1184
1184
|
|
|
1185
|
-
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {
|
|
1185
|
+
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
|
|
1186
1186
|
|
|
1187
1187
|
|
|
1188
1188
|
|
|
@@ -1276,7 +1276,7 @@ Will result in an Object representation of a BTTVEmote</p></li></ul></dd>
|
|
|
1276
1276
|
</dt>
|
|
1277
1277
|
<dd>
|
|
1278
1278
|
|
|
1279
|
-
<span class="param-type">
|
|
1279
|
+
<span class="param-type">object</span>
|
|
1280
1280
|
|
|
1281
1281
|
|
|
1282
1282
|
|
|
@@ -1390,7 +1390,7 @@ Will result in an Object representation of a BTTVEmote</p></li></ul></dd>
|
|
|
1390
1390
|
<td class="type">
|
|
1391
1391
|
|
|
1392
1392
|
|
|
1393
|
-
<span class="param-type">
|
|
1393
|
+
<span class="param-type">object</span>
|
|
1394
1394
|
|
|
1395
1395
|
|
|
1396
1396
|
|
|
@@ -1519,7 +1519,7 @@ Will result in an Object representation of a BTTVEmote</p></li></ul></dd>
|
|
|
1519
1519
|
<br class="clear">
|
|
1520
1520
|
|
|
1521
1521
|
<footer>
|
|
1522
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
1522
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
1523
1523
|
</footer>
|
|
1524
1524
|
|
|
1525
1525
|
<script>prettyPrint();</script>
|
package/docs/Channel.html
CHANGED
|
@@ -811,7 +811,7 @@ For the global channel, the ID will be null.</p>
|
|
|
811
811
|
<br class="clear">
|
|
812
812
|
|
|
813
813
|
<footer>
|
|
814
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
814
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
815
815
|
</footer>
|
|
816
816
|
|
|
817
817
|
<script>prettyPrint();</script>
|
package/docs/Collection.html
CHANGED
|
@@ -785,7 +785,7 @@ Same as <code>Array#map</code>.</p></li></ul></dd>
|
|
|
785
785
|
<br class="clear">
|
|
786
786
|
|
|
787
787
|
<footer>
|
|
788
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
788
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
789
789
|
</footer>
|
|
790
790
|
|
|
791
791
|
<script>prettyPrint();</script>
|
package/docs/Emote.html
CHANGED
|
@@ -669,7 +669,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
|
669
669
|
|
|
670
670
|
|
|
671
671
|
|
|
672
|
-
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {
|
|
672
|
+
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
|
|
673
673
|
|
|
674
674
|
|
|
675
675
|
|
|
@@ -758,7 +758,7 @@ Will result in an Object representation of an Emote</p></li></ul></dd>
|
|
|
758
758
|
</dt>
|
|
759
759
|
<dd>
|
|
760
760
|
|
|
761
|
-
<span class="param-type">
|
|
761
|
+
<span class="param-type">object</span>
|
|
762
762
|
|
|
763
763
|
|
|
764
764
|
|
|
@@ -789,7 +789,7 @@ Will result in an Object representation of an Emote</p></li></ul></dd>
|
|
|
789
789
|
<br class="clear">
|
|
790
790
|
|
|
791
791
|
<footer>
|
|
792
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
792
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
793
793
|
</footer>
|
|
794
794
|
|
|
795
795
|
<script>prettyPrint();</script>
|
package/docs/EmoteFetcher.html
CHANGED
|
@@ -206,7 +206,7 @@
|
|
|
206
206
|
<td class="type">
|
|
207
207
|
|
|
208
208
|
|
|
209
|
-
<span class="param-type">
|
|
209
|
+
<span class="param-type">object</span>
|
|
210
210
|
|
|
211
211
|
|
|
212
212
|
|
|
@@ -839,7 +839,7 @@ Collectionped by emote code to Emote instance.</p>
|
|
|
839
839
|
<td class="type">
|
|
840
840
|
|
|
841
841
|
|
|
842
|
-
<span class="param-type">
|
|
842
|
+
<span class="param-type">object</span>
|
|
843
843
|
|
|
844
844
|
|
|
845
845
|
|
|
@@ -1085,7 +1085,7 @@ Collectionped by emote code to Emote instance.</p>
|
|
|
1085
1085
|
<td class="type">
|
|
1086
1086
|
|
|
1087
1087
|
|
|
1088
|
-
<span class="param-type">
|
|
1088
|
+
<span class="param-type">object</span>
|
|
1089
1089
|
|
|
1090
1090
|
|
|
1091
1091
|
|
|
@@ -1331,7 +1331,7 @@ Collectionped by emote code to Emote instance.</p>
|
|
|
1331
1331
|
<td class="type">
|
|
1332
1332
|
|
|
1333
1333
|
|
|
1334
|
-
<span class="param-type">
|
|
1334
|
+
<span class="param-type">object</span>
|
|
1335
1335
|
|
|
1336
1336
|
|
|
1337
1337
|
|
|
@@ -1613,7 +1613,7 @@ Collectionped by emote code to Emote instance.</p>
|
|
|
1613
1613
|
<td class="type">
|
|
1614
1614
|
|
|
1615
1615
|
|
|
1616
|
-
<span class="param-type">
|
|
1616
|
+
<span class="param-type">object</span>
|
|
1617
1617
|
|
|
1618
1618
|
|
|
1619
1619
|
|
|
@@ -1725,7 +1725,7 @@ Collectionped by emote code to Emote instance.</p>
|
|
|
1725
1725
|
|
|
1726
1726
|
|
|
1727
1727
|
|
|
1728
|
-
<h4 class="name" id="_getRawBTTVEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawBTTVEmotes<span class="signature">(id<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<
|
|
1728
|
+
<h4 class="name" id="_getRawBTTVEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawBTTVEmotes<span class="signature">(id<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<object>>}</span></h4>
|
|
1729
1729
|
|
|
1730
1730
|
|
|
1731
1731
|
|
|
@@ -1884,7 +1884,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
1884
1884
|
</dt>
|
|
1885
1885
|
<dd>
|
|
1886
1886
|
|
|
1887
|
-
<span class="param-type">Promise.<Array.<
|
|
1887
|
+
<span class="param-type">Promise.<Array.<object>></span>
|
|
1888
1888
|
|
|
1889
1889
|
|
|
1890
1890
|
|
|
@@ -1900,7 +1900,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
1900
1900
|
|
|
1901
1901
|
|
|
1902
1902
|
|
|
1903
|
-
<h4 class="name" id="_getRawFFZEmoteSet"><span class="type-signature type-signature-private">(private) </span>_getRawFFZEmoteSet<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<
|
|
1903
|
+
<h4 class="name" id="_getRawFFZEmoteSet"><span class="type-signature type-signature-private">(private) </span>_getRawFFZEmoteSet<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<object>>}</span></h4>
|
|
1904
1904
|
|
|
1905
1905
|
|
|
1906
1906
|
|
|
@@ -2038,7 +2038,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2038
2038
|
</dt>
|
|
2039
2039
|
<dd>
|
|
2040
2040
|
|
|
2041
|
-
<span class="param-type">Promise.<Array.<
|
|
2041
|
+
<span class="param-type">Promise.<Array.<object>></span>
|
|
2042
2042
|
|
|
2043
2043
|
|
|
2044
2044
|
|
|
@@ -2054,7 +2054,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2054
2054
|
|
|
2055
2055
|
|
|
2056
2056
|
|
|
2057
|
-
<h4 class="name" id="_getRawFFZEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawFFZEmotes<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<
|
|
2057
|
+
<h4 class="name" id="_getRawFFZEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawFFZEmotes<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<object>>}</span></h4>
|
|
2058
2058
|
|
|
2059
2059
|
|
|
2060
2060
|
|
|
@@ -2192,7 +2192,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2192
2192
|
</dt>
|
|
2193
2193
|
<dd>
|
|
2194
2194
|
|
|
2195
|
-
<span class="param-type">Promise.<Array.<
|
|
2195
|
+
<span class="param-type">Promise.<Array.<object>></span>
|
|
2196
2196
|
|
|
2197
2197
|
|
|
2198
2198
|
|
|
@@ -2208,7 +2208,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2208
2208
|
|
|
2209
2209
|
|
|
2210
2210
|
|
|
2211
|
-
<h4 class="name" id="_getRawSevenTVEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawSevenTVEmotes<span class="signature">(id<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<
|
|
2211
|
+
<h4 class="name" id="_getRawSevenTVEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawSevenTVEmotes<span class="signature">(id<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<object>>}</span></h4>
|
|
2212
2212
|
|
|
2213
2213
|
|
|
2214
2214
|
|
|
@@ -2366,7 +2366,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2366
2366
|
</dt>
|
|
2367
2367
|
<dd>
|
|
2368
2368
|
|
|
2369
|
-
<span class="param-type">Promise.<Array.<
|
|
2369
|
+
<span class="param-type">Promise.<Array.<object>></span>
|
|
2370
2370
|
|
|
2371
2371
|
|
|
2372
2372
|
|
|
@@ -2382,7 +2382,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2382
2382
|
|
|
2383
2383
|
|
|
2384
2384
|
|
|
2385
|
-
<h4 class="name" id="_getRawTwitchEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawTwitchEmotes<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<
|
|
2385
|
+
<h4 class="name" id="_getRawTwitchEmotes"><span class="type-signature type-signature-private">(private) </span>_getRawTwitchEmotes<span class="signature">(id)</span><span class="type-signature"> → {Promise.<Array.<object>>}</span></h4>
|
|
2386
2386
|
|
|
2387
2387
|
|
|
2388
2388
|
|
|
@@ -2520,7 +2520,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
2520
2520
|
</dt>
|
|
2521
2521
|
<dd>
|
|
2522
2522
|
|
|
2523
|
-
<span class="param-type">Promise.<Array.<
|
|
2523
|
+
<span class="param-type">Promise.<Array.<object>></span>
|
|
2524
2524
|
|
|
2525
2525
|
|
|
2526
2526
|
|
|
@@ -3583,7 +3583,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
3583
3583
|
<td class="type">
|
|
3584
3584
|
|
|
3585
3585
|
|
|
3586
|
-
<span class="param-type">
|
|
3586
|
+
<span class="param-type">object</span>
|
|
3587
3587
|
|
|
3588
3588
|
|
|
3589
3589
|
|
|
@@ -3668,7 +3668,7 @@ Use <code>null</code> for the global emotes channel.</p></li></ul></dd>
|
|
|
3668
3668
|
<br class="clear">
|
|
3669
3669
|
|
|
3670
3670
|
<footer>
|
|
3671
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
3671
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
3672
3672
|
</footer>
|
|
3673
3673
|
|
|
3674
3674
|
<script>prettyPrint();</script>
|
package/docs/EmoteParser.html
CHANGED
|
@@ -198,7 +198,7 @@
|
|
|
198
198
|
<td class="type">
|
|
199
199
|
|
|
200
200
|
|
|
201
|
-
<span class="param-type">
|
|
201
|
+
<span class="param-type">object</span>
|
|
202
202
|
|
|
203
203
|
|
|
204
204
|
|
|
@@ -507,7 +507,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
507
507
|
|
|
508
508
|
|
|
509
509
|
|
|
510
|
-
<h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :
|
|
510
|
+
<h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :object</span></h4>
|
|
511
511
|
|
|
512
512
|
|
|
513
513
|
|
|
@@ -571,7 +571,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
571
571
|
<ul>
|
|
572
572
|
<li>
|
|
573
573
|
|
|
574
|
-
<span class="param-type">
|
|
574
|
+
<span class="param-type">object</span>
|
|
575
575
|
|
|
576
576
|
|
|
577
577
|
|
|
@@ -799,7 +799,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
799
799
|
<br class="clear">
|
|
800
800
|
|
|
801
801
|
<footer>
|
|
802
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
802
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
803
803
|
</footer>
|
|
804
804
|
|
|
805
805
|
<script>prettyPrint();</script>
|
package/docs/FFZEmote.html
CHANGED
|
@@ -1336,7 +1336,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
|
1336
1336
|
|
|
1337
1337
|
|
|
1338
1338
|
|
|
1339
|
-
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {
|
|
1339
|
+
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
|
|
1340
1340
|
|
|
1341
1341
|
|
|
1342
1342
|
|
|
@@ -1430,7 +1430,7 @@ Will result in an Object representation of a FFZEmote</p></li></ul></dd>
|
|
|
1430
1430
|
</dt>
|
|
1431
1431
|
<dd>
|
|
1432
1432
|
|
|
1433
|
-
<span class="param-type">
|
|
1433
|
+
<span class="param-type">object</span>
|
|
1434
1434
|
|
|
1435
1435
|
|
|
1436
1436
|
|
|
@@ -1544,7 +1544,7 @@ Will result in an Object representation of a FFZEmote</p></li></ul></dd>
|
|
|
1544
1544
|
<td class="type">
|
|
1545
1545
|
|
|
1546
1546
|
|
|
1547
|
-
<span class="param-type">
|
|
1547
|
+
<span class="param-type">object</span>
|
|
1548
1548
|
|
|
1549
1549
|
|
|
1550
1550
|
|
|
@@ -1673,7 +1673,7 @@ Will result in an Object representation of a FFZEmote</p></li></ul></dd>
|
|
|
1673
1673
|
<br class="clear">
|
|
1674
1674
|
|
|
1675
1675
|
<footer>
|
|
1676
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
1676
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
1677
1677
|
</footer>
|
|
1678
1678
|
|
|
1679
1679
|
<script>prettyPrint();</script>
|
package/docs/SevenTVEmote.html
CHANGED
|
@@ -1258,7 +1258,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
|
1258
1258
|
|
|
1259
1259
|
|
|
1260
1260
|
|
|
1261
|
-
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {
|
|
1261
|
+
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
|
|
1262
1262
|
|
|
1263
1263
|
|
|
1264
1264
|
|
|
@@ -1352,7 +1352,7 @@ Will result in an Object representation of a SevenTVEmote</p></li></ul></dd>
|
|
|
1352
1352
|
</dt>
|
|
1353
1353
|
<dd>
|
|
1354
1354
|
|
|
1355
|
-
<span class="param-type">
|
|
1355
|
+
<span class="param-type">object</span>
|
|
1356
1356
|
|
|
1357
1357
|
|
|
1358
1358
|
|
|
@@ -1464,7 +1464,7 @@ Will result in an Object representation of a SevenTVEmote</p></li></ul></dd>
|
|
|
1464
1464
|
<td class="type">
|
|
1465
1465
|
|
|
1466
1466
|
|
|
1467
|
-
<span class="param-type">
|
|
1467
|
+
<span class="param-type">object</span>
|
|
1468
1468
|
|
|
1469
1469
|
|
|
1470
1470
|
|
|
@@ -1583,7 +1583,7 @@ Will result in an Object representation of a SevenTVEmote</p></li></ul></dd>
|
|
|
1583
1583
|
<br class="clear">
|
|
1584
1584
|
|
|
1585
1585
|
<footer>
|
|
1586
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
1586
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
1587
1587
|
</footer>
|
|
1588
1588
|
|
|
1589
1589
|
<script>prettyPrint();</script>
|
package/docs/TwitchEmote.html
CHANGED
|
@@ -1178,7 +1178,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
|
1178
1178
|
|
|
1179
1179
|
|
|
1180
1180
|
|
|
1181
|
-
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {
|
|
1181
|
+
<h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
|
|
1182
1182
|
|
|
1183
1183
|
|
|
1184
1184
|
|
|
@@ -1272,7 +1272,7 @@ Will result in an Object representation of a TwitchEmote</p></li></ul></dd>
|
|
|
1272
1272
|
</dt>
|
|
1273
1273
|
<dd>
|
|
1274
1274
|
|
|
1275
|
-
<span class="param-type">
|
|
1275
|
+
<span class="param-type">object</span>
|
|
1276
1276
|
|
|
1277
1277
|
|
|
1278
1278
|
|
|
@@ -1386,7 +1386,7 @@ Will result in an Object representation of a TwitchEmote</p></li></ul></dd>
|
|
|
1386
1386
|
<td class="type">
|
|
1387
1387
|
|
|
1388
1388
|
|
|
1389
|
-
<span class="param-type">
|
|
1389
|
+
<span class="param-type">object</span>
|
|
1390
1390
|
|
|
1391
1391
|
|
|
1392
1392
|
|
|
@@ -1515,7 +1515,7 @@ Will result in an Object representation of a TwitchEmote</p></li></ul></dd>
|
|
|
1515
1515
|
<br class="clear">
|
|
1516
1516
|
|
|
1517
1517
|
<footer>
|
|
1518
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
1518
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
1519
1519
|
</footer>
|
|
1520
1520
|
|
|
1521
1521
|
<script>prettyPrint();</script>
|
package/docs/index.html
CHANGED
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
<section class="package">
|
|
47
|
-
<h3>@mkody/twitch-emoticons 2.8.
|
|
47
|
+
<h3>@mkody/twitch-emoticons 2.8.8</h3>
|
|
48
48
|
</section>
|
|
49
49
|
|
|
50
50
|
|
|
@@ -220,7 +220,7 @@ fetcher.fromObject(emotes);
|
|
|
220
220
|
<br class="clear">
|
|
221
221
|
|
|
222
222
|
<footer>
|
|
223
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
223
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
224
224
|
</footer>
|
|
225
225
|
|
|
226
226
|
<script>prettyPrint();</script>
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
<pre class="prettyprint source linenums"><code>const Emote = require('./Emote');
|
|
49
49
|
const Constants = require('../util/Constants');
|
|
50
50
|
|
|
51
|
-
/** @
|
|
51
|
+
/** @augments Emote */
|
|
52
52
|
class BTTVEmote extends Emote {
|
|
53
53
|
/**
|
|
54
54
|
* A BTTV emote.
|
|
@@ -106,7 +106,7 @@ class BTTVEmote extends Emote {
|
|
|
106
106
|
/**
|
|
107
107
|
* Override for `toObject`.
|
|
108
108
|
* Will result in an Object representation of a BTTVEmote
|
|
109
|
-
* @returns {
|
|
109
|
+
* @returns {object}
|
|
110
110
|
*/
|
|
111
111
|
toObject() {
|
|
112
112
|
return Object.assign({}, super.toObject(), {
|
|
@@ -118,7 +118,7 @@ class BTTVEmote extends Emote {
|
|
|
118
118
|
|
|
119
119
|
/**
|
|
120
120
|
* Converts an emote Object into a BTTVEmote
|
|
121
|
-
* @param {
|
|
121
|
+
* @param {object} [emoteObject] - Object representation of this emote
|
|
122
122
|
* @param {Channel} [channel=null] - Channel this emote belongs to.
|
|
123
123
|
* @returns {BTTVEmote}
|
|
124
124
|
*/
|
|
@@ -149,7 +149,7 @@ module.exports = BTTVEmote;
|
|
|
149
149
|
<br class="clear">
|
|
150
150
|
|
|
151
151
|
<footer>
|
|
152
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
152
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
153
153
|
</footer>
|
|
154
154
|
|
|
155
155
|
<script>prettyPrint();</script>
|
|
@@ -119,7 +119,7 @@ module.exports = Channel;
|
|
|
119
119
|
<br class="clear">
|
|
120
120
|
|
|
121
121
|
<footer>
|
|
122
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
122
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
123
123
|
</footer>
|
|
124
124
|
|
|
125
125
|
<script>prettyPrint();</script>
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
/**
|
|
120
120
|
* Override for `toObject`.
|
|
121
121
|
* Will result in an Object representation of an Emote
|
|
122
|
-
* @returns {
|
|
122
|
+
* @returns {object}
|
|
123
123
|
*/
|
|
124
124
|
toObject() {
|
|
125
125
|
return {
|
|
@@ -145,7 +145,7 @@ module.exports = Emote;
|
|
|
145
145
|
<br class="clear">
|
|
146
146
|
|
|
147
147
|
<footer>
|
|
148
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
148
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
149
149
|
</footer>
|
|
150
150
|
|
|
151
151
|
<script>prettyPrint();</script>
|
|
@@ -62,9 +62,9 @@ class EmoteFetcher {
|
|
|
62
62
|
* Fetches and caches emotes.
|
|
63
63
|
* @param {string} clientId The client id for the twitch api.
|
|
64
64
|
* @param {string} clientSecret The client secret for the twitch api.
|
|
65
|
-
* @param {
|
|
65
|
+
* @param {object} options Additional options.
|
|
66
66
|
* @param {ApiClient} options.apiClient - Bring your own Twurple ApiClient.
|
|
67
|
-
|
|
67
|
+
*/
|
|
68
68
|
constructor(clientId, clientSecret, options) {
|
|
69
69
|
if (options && options.apiClient) {
|
|
70
70
|
this.apiClient = options.apiClient;
|
|
@@ -128,7 +128,7 @@ class EmoteFetcher {
|
|
|
128
128
|
* Gets the raw Twitch emotes data for a channel.
|
|
129
129
|
* @private
|
|
130
130
|
* @param {int} id - ID of the channel.
|
|
131
|
-
* @returns {Promise<
|
|
131
|
+
* @returns {Promise<object[]>}
|
|
132
132
|
*/
|
|
133
133
|
_getRawTwitchEmotes(id) {
|
|
134
134
|
if (!this.apiClient) {
|
|
@@ -146,7 +146,7 @@ class EmoteFetcher {
|
|
|
146
146
|
* Converts and caches a raw twitch emote.
|
|
147
147
|
* @private
|
|
148
148
|
* @param {int} channel_id - ID of the channel.
|
|
149
|
-
* @param {
|
|
149
|
+
* @param {object} data - Raw data.
|
|
150
150
|
* @param {TwitchEmote} [existing_emote=null] - Existing emote to cache.
|
|
151
151
|
* @returns {TwitchEmote}
|
|
152
152
|
*/
|
|
@@ -163,7 +163,7 @@ class EmoteFetcher {
|
|
|
163
163
|
* Use `null` for the global emotes channel.
|
|
164
164
|
* @private
|
|
165
165
|
* @param {int} [id=null] - ID of the channel.
|
|
166
|
-
* @returns {Promise<
|
|
166
|
+
* @returns {Promise<object[]>}
|
|
167
167
|
*/
|
|
168
168
|
_getRawBTTVEmotes(id) {
|
|
169
169
|
const endpoint = !id
|
|
@@ -182,7 +182,7 @@ class EmoteFetcher {
|
|
|
182
182
|
* Converts and caches a raw BTTV emote.
|
|
183
183
|
* @private
|
|
184
184
|
* @param {int} channel_id - ID of the channel.
|
|
185
|
-
* @param {
|
|
185
|
+
* @param {object} data - Raw data.
|
|
186
186
|
* @param {BTTVEmote} [existing_emote=null] - Existing emote to cache.
|
|
187
187
|
* @returns {BTTVEmote}
|
|
188
188
|
*/
|
|
@@ -198,7 +198,7 @@ class EmoteFetcher {
|
|
|
198
198
|
* Gets the raw FFZ emote data from a set.
|
|
199
199
|
* @private
|
|
200
200
|
* @param {int} id - ID of the set.
|
|
201
|
-
* @returns {Promise<
|
|
201
|
+
* @returns {Promise<object[]>}
|
|
202
202
|
*/
|
|
203
203
|
_getRawFFZEmoteSet(id) {
|
|
204
204
|
const endpoint = Constants.FFZ.Set(id); // eslint-disable-line new-cap
|
|
@@ -212,7 +212,7 @@ class EmoteFetcher {
|
|
|
212
212
|
* Gets the raw FFZ emotes data for a channel.
|
|
213
213
|
* @private
|
|
214
214
|
* @param {int} id - ID of the channel.
|
|
215
|
-
* @returns {Promise<
|
|
215
|
+
* @returns {Promise<object[]>}
|
|
216
216
|
*/
|
|
217
217
|
_getRawFFZEmotes(id) {
|
|
218
218
|
const endpoint = Constants.FFZ.Channel(id); // eslint-disable-line new-cap
|
|
@@ -232,7 +232,7 @@ class EmoteFetcher {
|
|
|
232
232
|
* Converts and caches a raw FFZ emote.
|
|
233
233
|
* @private
|
|
234
234
|
* @param {int} channel_id - ID of the channel.
|
|
235
|
-
* @param {
|
|
235
|
+
* @param {object} data - Raw data.
|
|
236
236
|
* @param {FFZEmote} [existing_emote=null] - Existing emote to cache.
|
|
237
237
|
* @returns {FFZEmote}
|
|
238
238
|
*/
|
|
@@ -248,7 +248,7 @@ class EmoteFetcher {
|
|
|
248
248
|
* Gets the raw 7TV emotes data for a channel.
|
|
249
249
|
* @private
|
|
250
250
|
* @param {int} [id=null] - ID of the channel.
|
|
251
|
-
* @returns {Promise<
|
|
251
|
+
* @returns {Promise<object[]>}
|
|
252
252
|
*/
|
|
253
253
|
_getRawSevenTVEmotes(id) {
|
|
254
254
|
const endpoint = !id
|
|
@@ -262,7 +262,7 @@ class EmoteFetcher {
|
|
|
262
262
|
* Converts and caches a raw 7TV emote.
|
|
263
263
|
* @private
|
|
264
264
|
* @param {int} channel_id - ID of the channel.
|
|
265
|
-
* @param {
|
|
265
|
+
* @param {object} data - Raw data.
|
|
266
266
|
* @param {string} format - The type file format to use (webp/avif).
|
|
267
267
|
* @param {SevenTVEmote} [existing_emote=null] - Existing emote to cache.
|
|
268
268
|
* @returns {SevenTVEmote}
|
|
@@ -372,7 +372,7 @@ class EmoteFetcher {
|
|
|
372
372
|
|
|
373
373
|
/**
|
|
374
374
|
* Converts emote Objects to emotes
|
|
375
|
-
* @param {
|
|
375
|
+
* @param {object} [emotesArray] - An array of emote objects
|
|
376
376
|
* @returns {Emote[]}
|
|
377
377
|
*/
|
|
378
378
|
fromObject(emotesArray) {
|
|
@@ -414,7 +414,7 @@ module.exports = EmoteFetcher;
|
|
|
414
414
|
<br class="clear">
|
|
415
415
|
|
|
416
416
|
<footer>
|
|
417
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
417
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
418
418
|
</footer>
|
|
419
419
|
|
|
420
420
|
<script>prettyPrint();</script>
|
|
@@ -51,7 +51,7 @@ class EmoteParser {
|
|
|
51
51
|
/**
|
|
52
52
|
* A parser to replace text with emotes.
|
|
53
53
|
* @param {EmoteFetcher} fetcher - The fetcher to use the cache of.
|
|
54
|
-
* @param {
|
|
54
|
+
* @param {object} [options={}] - Options for the parser.
|
|
55
55
|
* @param {string} [options.template] - The template to be used.
|
|
56
56
|
* The strings that can be interpolated are:
|
|
57
57
|
* - `{link}` The link of the emote.
|
|
@@ -73,7 +73,7 @@ class EmoteParser {
|
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
75
|
* The parser options.
|
|
76
|
-
* @type {
|
|
76
|
+
* @type {object}
|
|
77
77
|
*/
|
|
78
78
|
this.options = Object.assign({
|
|
79
79
|
template: '',
|
|
@@ -140,7 +140,7 @@ module.exports = EmoteParser;
|
|
|
140
140
|
<br class="clear">
|
|
141
141
|
|
|
142
142
|
<footer>
|
|
143
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
143
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
144
144
|
</footer>
|
|
145
145
|
|
|
146
146
|
<script>prettyPrint();</script>
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
<pre class="prettyprint source linenums"><code>const Emote = require('./Emote');
|
|
49
49
|
const Constants = require('../util/Constants');
|
|
50
50
|
|
|
51
|
-
/** @
|
|
51
|
+
/** @augments Emote */
|
|
52
52
|
class FFZEmote extends Emote {
|
|
53
53
|
/**
|
|
54
54
|
* An FFZ emote.
|
|
@@ -120,7 +120,7 @@ class FFZEmote extends Emote {
|
|
|
120
120
|
/**
|
|
121
121
|
* Override for `toObject`.
|
|
122
122
|
* Will result in an Object representation of a FFZEmote
|
|
123
|
-
* @returns {
|
|
123
|
+
* @returns {object}
|
|
124
124
|
*/
|
|
125
125
|
toObject() {
|
|
126
126
|
return Object.assign({}, super.toObject(), {
|
|
@@ -134,7 +134,7 @@ class FFZEmote extends Emote {
|
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
136
|
* Converts an emote Object into a FFZEmote
|
|
137
|
-
* @param {
|
|
137
|
+
* @param {object} [emoteObject] - Object representation of this emote
|
|
138
138
|
* @param {Channel} [channel=null] - Channel this emote belongs to.
|
|
139
139
|
* @returns {FFZEmote}
|
|
140
140
|
*/
|
|
@@ -172,7 +172,7 @@ module.exports = FFZEmote;
|
|
|
172
172
|
<br class="clear">
|
|
173
173
|
|
|
174
174
|
<footer>
|
|
175
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
175
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
176
176
|
</footer>
|
|
177
177
|
|
|
178
178
|
<script>prettyPrint();</script>
|