@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.
- package/.jsdoc.json +5 -0
- package/LICENSE +1 -0
- package/README.md +85 -13
- package/docs/BTTVEmote.html +87 -37
- package/docs/Channel.html +165 -42
- package/docs/Collection.html +42 -36
- package/docs/Emote.html +58 -25
- package/docs/EmoteFetcher.html +2694 -2075
- package/docs/EmoteParser.html +39 -20
- package/docs/FFZEmote.html +91 -37
- package/docs/SevenTV.html +1191 -0
- package/docs/SevenTVEmote.html +1318 -0
- package/docs/TwitchEmote.html +85 -37
- package/docs/index.html +201 -132
- package/docs/scripts/collapse.js +19 -0
- package/docs/scripts/commonNav.js +28 -0
- package/docs/scripts/search.js +16 -0
- package/docs/struct_BTTVEmote.js.html +5 -2
- package/docs/struct_Channel.js.html +21 -10
- package/docs/struct_Emote.js.html +6 -3
- package/docs/struct_EmoteFetcher.js.html +168 -109
- package/docs/struct_EmoteParser.js.html +5 -2
- package/docs/struct_FFZEmote.js.html +5 -2
- package/docs/struct_SevenTVEmote.js.html +135 -0
- package/docs/struct_TwitchEmote.js.html +5 -2
- package/docs/styles/jsdoc.css +13 -2
- package/docs/styles/prettify.css +1 -0
- package/docs/util_Collection.js.html +5 -2
- package/package.json +15 -13
- package/src/index.js +4 -3
- package/src/struct/Channel.js +16 -8
- package/src/struct/Emote.js +1 -1
- package/src/struct/EmoteFetcher.js +96 -40
- package/src/struct/SevenTVEmote.js +63 -0
- package/src/util/Constants.js +5 -1
- package/test/index.js +39 -3
- package/typings/index.d.ts +35 -18
- package/typings/test.ts +0 -24
package/docs/EmoteParser.html
CHANGED
|
@@ -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
|
-
|
|
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
|
-
|
|
51
|
+
|
|
52
|
+
EmoteParser
|
|
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 parser to replace text with emotes.</p></li></ul></dd>
|
|
78
|
+
|
|
70
79
|
|
|
71
80
|
|
|
72
81
|
<dt class="tag-source">Source:</dt>
|
|
@@ -110,9 +119,6 @@
|
|
|
110
119
|
|
|
111
120
|
|
|
112
121
|
|
|
113
|
-
<div class="description usertext">
|
|
114
|
-
<p>A parser to replace text with emotes.</p>
|
|
115
|
-
</div>
|
|
116
122
|
|
|
117
123
|
|
|
118
124
|
|
|
@@ -121,10 +127,7 @@
|
|
|
121
127
|
|
|
122
128
|
|
|
123
129
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
<h5>Parameters:</h5>
|
|
130
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
128
131
|
|
|
129
132
|
|
|
130
133
|
<table class="params">
|
|
@@ -162,6 +165,7 @@
|
|
|
162
165
|
<span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
|
|
163
166
|
|
|
164
167
|
|
|
168
|
+
|
|
165
169
|
|
|
166
170
|
</td>
|
|
167
171
|
|
|
@@ -197,6 +201,7 @@
|
|
|
197
201
|
<span class="param-type">Object</span>
|
|
198
202
|
|
|
199
203
|
|
|
204
|
+
|
|
200
205
|
|
|
201
206
|
</td>
|
|
202
207
|
|
|
@@ -259,6 +264,7 @@
|
|
|
259
264
|
<span class="param-type">string</span>
|
|
260
265
|
|
|
261
266
|
|
|
267
|
+
|
|
262
268
|
|
|
263
269
|
</td>
|
|
264
270
|
|
|
@@ -303,6 +309,7 @@ The strings that can be interpolated are:</p>
|
|
|
303
309
|
<span class="param-type">string</span>
|
|
304
310
|
|
|
305
311
|
|
|
312
|
+
|
|
306
313
|
|
|
307
314
|
</td>
|
|
308
315
|
|
|
@@ -344,6 +351,7 @@ If the <code>template</code> option is provided, this is ignored.</p></td>
|
|
|
344
351
|
<span class="param-type">RegExp</span>
|
|
345
352
|
|
|
346
353
|
|
|
354
|
+
|
|
347
355
|
|
|
348
356
|
</td>
|
|
349
357
|
|
|
@@ -428,6 +436,10 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
428
436
|
|
|
429
437
|
|
|
430
438
|
<dl class="details">
|
|
439
|
+
|
|
440
|
+
<dt class="tag-description">Description:</dt>
|
|
441
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher being used.</p></li></ul></dd>
|
|
442
|
+
|
|
431
443
|
|
|
432
444
|
|
|
433
445
|
<dt class="tag-source">Source:</dt>
|
|
@@ -477,13 +489,14 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
477
489
|
|
|
478
490
|
|
|
479
491
|
|
|
480
|
-
<h5>Type:</h5>
|
|
492
|
+
<h5 class="h5-types">Type:</h5>
|
|
481
493
|
<ul>
|
|
482
494
|
<li>
|
|
483
495
|
|
|
484
496
|
<span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
|
|
485
497
|
|
|
486
498
|
|
|
499
|
+
|
|
487
500
|
</li>
|
|
488
501
|
</ul>
|
|
489
502
|
|
|
@@ -501,6 +514,10 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
501
514
|
|
|
502
515
|
|
|
503
516
|
<dl class="details">
|
|
517
|
+
|
|
518
|
+
<dt class="tag-description">Description:</dt>
|
|
519
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The parser options.</p></li></ul></dd>
|
|
520
|
+
|
|
504
521
|
|
|
505
522
|
|
|
506
523
|
<dt class="tag-source">Source:</dt>
|
|
@@ -550,13 +567,14 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
550
567
|
|
|
551
568
|
|
|
552
569
|
|
|
553
|
-
<h5>Type:</h5>
|
|
570
|
+
<h5 class="h5-types">Type:</h5>
|
|
554
571
|
<ul>
|
|
555
572
|
<li>
|
|
556
573
|
|
|
557
574
|
<span class="param-type">Object</span>
|
|
558
575
|
|
|
559
576
|
|
|
577
|
+
|
|
560
578
|
</li>
|
|
561
579
|
</ul>
|
|
562
580
|
|
|
@@ -584,6 +602,10 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
584
602
|
|
|
585
603
|
|
|
586
604
|
<dl class="details">
|
|
605
|
+
|
|
606
|
+
<dt class="tag-description">Description:</dt>
|
|
607
|
+
<dd class="tag-description"><ul class="dummy"><li><p>Parses text.</p></li></ul></dd>
|
|
608
|
+
|
|
587
609
|
|
|
588
610
|
|
|
589
611
|
<dt class="tag-source">Source:</dt>
|
|
@@ -627,11 +649,6 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
627
649
|
|
|
628
650
|
|
|
629
651
|
|
|
630
|
-
<div class="description usertext">
|
|
631
|
-
<p>Parses text.</p>
|
|
632
|
-
</div>
|
|
633
|
-
|
|
634
|
-
|
|
635
652
|
|
|
636
653
|
|
|
637
654
|
|
|
@@ -640,8 +657,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
640
657
|
|
|
641
658
|
|
|
642
659
|
|
|
643
|
-
|
|
644
|
-
<h5>Parameters:</h5>
|
|
660
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
645
661
|
|
|
646
662
|
|
|
647
663
|
<table class="params">
|
|
@@ -677,6 +693,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
677
693
|
<span class="param-type">string</span>
|
|
678
694
|
|
|
679
695
|
|
|
696
|
+
|
|
680
697
|
|
|
681
698
|
</td>
|
|
682
699
|
|
|
@@ -704,6 +721,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
704
721
|
<span class="param-type">number</span>
|
|
705
722
|
|
|
706
723
|
|
|
724
|
+
|
|
707
725
|
|
|
708
726
|
</td>
|
|
709
727
|
|
|
@@ -739,7 +757,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
739
757
|
|
|
740
758
|
|
|
741
759
|
|
|
742
|
-
<h5>Returns:</h5>
|
|
760
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
743
761
|
|
|
744
762
|
|
|
745
763
|
|
|
@@ -753,6 +771,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
753
771
|
<span class="param-type">string</span>
|
|
754
772
|
|
|
755
773
|
|
|
774
|
+
|
|
756
775
|
</dd>
|
|
757
776
|
</dl>
|
|
758
777
|
|
|
@@ -780,7 +799,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
|
|
|
780
799
|
<br class="clear">
|
|
781
800
|
|
|
782
801
|
<footer>
|
|
783
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc
|
|
802
|
+
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.
|
|
784
803
|
</footer>
|
|
785
804
|
|
|
786
805
|
<script>prettyPrint();</script>
|