@mkody/twitch-emoticons 2.6.2 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/.eslintrc.json +143 -143
  2. package/.github/codeql/codeql-config.yml +4 -4
  3. package/.github/workflows/codeql.yml +50 -50
  4. package/.github/workflows/eslint.yml +50 -50
  5. package/.github/workflows/release.yml +22 -0
  6. package/.github/workflows/yarn-test.yml +17 -17
  7. package/.jsdoc.json +39 -39
  8. package/.nvmrc +1 -0
  9. package/LICENSE +22 -22
  10. package/README.md +13 -8
  11. package/docs/BTTVEmote.html +83 -5
  12. package/docs/Channel.html +1 -1
  13. package/docs/Collection.html +1 -1
  14. package/docs/Emote.html +3 -3
  15. package/docs/EmoteFetcher.html +271 -19
  16. package/docs/EmoteParser.html +1 -1
  17. package/docs/FFZEmote.html +162 -6
  18. package/docs/SevenTV.html +1190 -1190
  19. package/docs/SevenTVEmote.html +84 -6
  20. package/docs/TwitchEmote.html +83 -5
  21. package/docs/index.html +15 -10
  22. package/docs/struct_BTTVEmote.js.html +61 -55
  23. package/docs/struct_Channel.js.html +56 -56
  24. package/docs/struct_Emote.js.html +67 -66
  25. package/docs/struct_EmoteFetcher.js.html +324 -284
  26. package/docs/struct_EmoteParser.js.html +82 -81
  27. package/docs/struct_FFZEmote.js.html +75 -62
  28. package/docs/struct_SevenTVEmote.js.html +70 -64
  29. package/docs/struct_TwitchEmote.js.html +59 -53
  30. package/docs/util_Collection.js.html +79 -79
  31. package/package.json +57 -57
  32. package/src/index.js +12 -12
  33. package/src/struct/BTTVEmote.js +60 -54
  34. package/src/struct/Channel.js +55 -55
  35. package/src/struct/Emote.js +66 -65
  36. package/src/struct/EmoteFetcher.js +323 -283
  37. package/src/struct/EmoteParser.js +81 -80
  38. package/src/struct/FFZEmote.js +74 -61
  39. package/src/struct/SevenTVEmote.js +69 -63
  40. package/src/struct/TwitchEmote.js +58 -52
  41. package/src/util/Collection.js +78 -78
  42. package/src/util/Constants.js +31 -25
  43. package/test/index.js +174 -166
  44. package/typings/index.d.ts +98 -93
package/docs/FFZEmote.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
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</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><li data-type='method'><a href="Channel.html#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</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#_cacheSevenTVEmote">_cacheSevenTVEmote</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#_getRawSevenTVEmotes">_getRawSevenTVEmotes</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#fetchSevenTVEmotes">fetchSevenTVEmotes</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="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#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>
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</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><li data-type='method'><a href="Channel.html#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</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#_cacheSevenTVEmote">_cacheSevenTVEmote</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#_getRawFFZEmoteSet">_getRawFFZEmoteSet</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawSevenTVEmotes">_getRawSevenTVEmotes</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#fetchSevenTVEmotes">fetchSevenTVEmotes</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="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#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>
33
33
 
34
34
  </nav>
35
35
 
@@ -274,6 +274,84 @@
274
274
 
275
275
 
276
276
 
277
+ <h4 class="name" id="animated"><span class="type-signature"></span>animated<span class="type-signature"> :boolean</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>If emote is animated.</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_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line47">line 47</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>If emote is animated.</p>
333
+ </div>
334
+
335
+
336
+
337
+ <h5 class="h5-types">Type:</h5>
338
+ <ul>
339
+ <li>
340
+
341
+ <span class="param-type">boolean</span>
342
+
343
+
344
+
345
+ </li>
346
+ </ul>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
277
355
  <h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
278
356
 
279
357
 
@@ -376,7 +454,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
376
454
 
377
455
  <dt class="tag-source">Source:</dt>
378
456
  <dd class="tag-source"><ul class="dummy"><li>
379
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line48">line 48</a>
457
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line49">line 49</a>
380
458
  </li></ul></dd>
381
459
 
382
460
 
@@ -625,7 +703,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
625
703
 
626
704
  <dt class="tag-source">Source:</dt>
627
705
  <dd class="tag-source"><ul class="dummy"><li>
628
- <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line47">line 47</a>
706
+ <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line53">line 53</a>
629
707
  </li></ul></dd>
630
708
 
631
709
 
@@ -688,6 +766,84 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
688
766
 
689
767
 
690
768
 
769
+ <h4 class="name" id="modifier"><span class="type-signature"></span>modifier<span class="type-signature"> :boolean</span></h4>
770
+
771
+
772
+
773
+
774
+
775
+ <dl class="details">
776
+
777
+ <dt class="tag-description">Description:</dt>
778
+ <dd class="tag-description"><ul class="dummy"><li><p>If the emote is a modifier and should be hidden.</p></li></ul></dd>
779
+
780
+
781
+
782
+ <dt class="tag-source">Source:</dt>
783
+ <dd class="tag-source"><ul class="dummy"><li>
784
+ <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line59">line 59</a>
785
+ </li></ul></dd>
786
+
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+ </dl>
818
+
819
+
820
+
821
+
822
+
823
+ <div class="description usertext">
824
+ <p>If the emote is a modifier and should be hidden.</p>
825
+ </div>
826
+
827
+
828
+
829
+ <h5 class="h5-types">Type:</h5>
830
+ <ul>
831
+ <li>
832
+
833
+ <span class="param-type">boolean</span>
834
+
835
+
836
+
837
+ </li>
838
+ </ul>
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
691
847
  <h4 class="name" id="owner"><span class="type-signature type-signature-readonly, nullable">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
692
848
 
693
849
 
@@ -768,7 +924,7 @@ Not guaranteed to contain the emote, or be cached.</p>
768
924
 
769
925
 
770
926
 
771
- <h4 class="name" id="ownerName"><span class="type-signature"></span>ownerName<span class="type-signature"> :string</span></h4>
927
+ <h4 class="name" id="ownerName"><span class="type-signature type-signature-nullable">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
772
928
 
773
929
 
774
930
 
@@ -1034,7 +1190,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
1034
1190
 
1035
1191
  <dt class="tag-source">Source:</dt>
1036
1192
  <dd class="tag-source"><ul class="dummy"><li>
1037
- <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line55">line 55</a>
1193
+ <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line67">line 67</a>
1038
1194
  </li></ul></dd>
1039
1195
 
1040
1196
 
@@ -1197,7 +1353,7 @@ Will give the emote's name.</p></li></ul></dd>
1197
1353
 
1198
1354
  <dt class="tag-source">Source:</dt>
1199
1355
  <dd class="tag-source"><ul class="dummy"><li>
1200
- <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line60">line 60</a>
1356
+ <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line61">line 61</a>
1201
1357
  </li></ul></dd>
1202
1358
 
1203
1359