@mkody/twitch-emoticons 2.4.1 → 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/docs/Channel.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
- <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
- Channel
51
+
52
+ Channel
53
+
49
54
  </h2>
50
55
 
51
56
 
@@ -59,7 +64,7 @@
59
64
 
60
65
 
61
66
 
62
- <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(fetcher, name)</span><span class="type-signature"></span></h4>
67
+ <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(fetcher, id)</span><span class="type-signature"></span></h4>
63
68
 
64
69
 
65
70
 
@@ -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 channel.</p></li></ul></dd>
78
+
70
79
 
71
80
 
72
81
  <dt class="tag-source">Source:</dt>
@@ -110,10 +119,6 @@
110
119
 
111
120
 
112
121
 
113
- <div class="description usertext">
114
- <p>A Twitch channel.</p>
115
- </div>
116
-
117
122
 
118
123
 
119
124
 
@@ -122,9 +127,7 @@
122
127
 
123
128
 
124
129
 
125
-
126
-
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="EmoteFetcher.html">EmoteFetcher</a></span>
159
162
 
160
163
 
164
+
161
165
 
162
166
  </td>
163
167
 
@@ -172,13 +176,14 @@
172
176
 
173
177
  <tr>
174
178
 
175
- <td class="name"><code>name</code></td>
179
+ <td class="name"><code>id</code></td>
176
180
 
177
181
 
178
182
  <td class="type">
179
183
 
180
184
 
181
- <span class="param-type">string</span>
185
+ <span class="param-type">int</span>
186
+
182
187
 
183
188
 
184
189
 
@@ -188,7 +193,7 @@
188
193
 
189
194
 
190
195
 
191
- <td class="description last"><p>The name of the channel.</p></td>
196
+ <td class="description last"><p>ID of the channel.</p></td>
192
197
  </tr>
193
198
 
194
199
 
@@ -234,18 +239,23 @@
234
239
 
235
240
 
236
241
 
237
- <h4 class="name" id="emotes"><span class="type-signature"></span>emotes<span class="type-signature"> :<a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span></h4>
242
+ <h4 class="name" id="channel_id"><span class="type-signature type-signature-nullable">(nullable) </span>channel_id<span class="type-signature"> :int</span></h4>
238
243
 
239
244
 
240
245
 
241
246
 
242
247
 
243
248
  <dl class="details">
249
+
250
+ <dt class="tag-description">Description:</dt>
251
+ <dd class="tag-description"><ul class="dummy"><li><p>The ID of this channel.<br>
252
+ For the global channel, the ID will be null.</p></li></ul></dd>
253
+
244
254
 
245
255
 
246
256
  <dt class="tag-source">Source:</dt>
247
257
  <dd class="tag-source"><ul class="dummy"><li>
248
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line27">line 27</a>
258
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line21">line 21</a>
249
259
  </li></ul></dd>
250
260
 
251
261
 
@@ -285,16 +295,18 @@
285
295
 
286
296
 
287
297
  <div class="description usertext">
288
- <p>Cached emotes belonging to this channel.</p>
298
+ <p>The ID of this channel.<br>
299
+ For the global channel, the ID will be null.</p>
289
300
  </div>
290
301
 
291
302
 
292
303
 
293
- <h5>Type:</h5>
304
+ <h5 class="h5-types">Type:</h5>
294
305
  <ul>
295
306
  <li>
296
307
 
297
- <span class="param-type"><a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span>
308
+ <span class="param-type">int</span>
309
+
298
310
 
299
311
 
300
312
  </li>
@@ -307,18 +319,22 @@
307
319
 
308
320
 
309
321
 
310
- <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
322
+ <h4 class="name" id="emotes"><span class="type-signature"></span>emotes<span class="type-signature"> :<a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span></h4>
311
323
 
312
324
 
313
325
 
314
326
 
315
327
 
316
328
  <dl class="details">
329
+
330
+ <dt class="tag-description">Description:</dt>
331
+ <dd class="tag-description"><ul class="dummy"><li><p>Cached emotes belonging to this channel.</p></li></ul></dd>
332
+
317
333
 
318
334
 
319
335
  <dt class="tag-source">Source:</dt>
320
336
  <dd class="tag-source"><ul class="dummy"><li>
321
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line14">line 14</a>
337
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line27">line 27</a>
322
338
  </li></ul></dd>
323
339
 
324
340
 
@@ -358,16 +374,17 @@
358
374
 
359
375
 
360
376
  <div class="description usertext">
361
- <p>The emote fetcher.</p>
377
+ <p>Cached emotes belonging to this channel.</p>
362
378
  </div>
363
379
 
364
380
 
365
381
 
366
- <h5>Type:</h5>
382
+ <h5 class="h5-types">Type:</h5>
367
383
  <ul>
368
384
  <li>
369
385
 
370
- <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
386
+ <span class="param-type"><a href="Collection.html">Collection</a>.&lt;string, <a href="Emote.html">Emote</a>></span>
387
+
371
388
 
372
389
 
373
390
  </li>
@@ -380,18 +397,22 @@
380
397
 
381
398
 
382
399
 
383
- <h4 class="name" id="name"><span class="type-signature">(nullable) </span>name<span class="type-signature"> :string</span></h4>
400
+ <h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
384
401
 
385
402
 
386
403
 
387
404
 
388
405
 
389
406
  <dl class="details">
407
+
408
+ <dt class="tag-description">Description:</dt>
409
+ <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
410
+
390
411
 
391
412
 
392
413
  <dt class="tag-source">Source:</dt>
393
414
  <dd class="tag-source"><ul class="dummy"><li>
394
- <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line21">line 21</a>
415
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line14">line 14</a>
395
416
  </li></ul></dd>
396
417
 
397
418
 
@@ -431,17 +452,17 @@
431
452
 
432
453
 
433
454
  <div class="description usertext">
434
- <p>The name of this channel.<br>
435
- For the global channel, the name will be null.</p>
455
+ <p>The emote fetcher.</p>
436
456
  </div>
437
457
 
438
458
 
439
459
 
440
- <h5>Type:</h5>
460
+ <h5 class="h5-types">Type:</h5>
441
461
  <ul>
442
462
  <li>
443
463
 
444
- <span class="param-type">string</span>
464
+ <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
465
+
445
466
 
446
467
 
447
468
  </li>
@@ -471,6 +492,10 @@ For the global channel, the name will be null.</p>
471
492
 
472
493
 
473
494
  <dl class="details">
495
+
496
+ <dt class="tag-description">Description:</dt>
497
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the BTTV emotes for this channel.</p></li></ul></dd>
498
+
474
499
 
475
500
 
476
501
  <dt class="tag-source">Source:</dt>
@@ -514,12 +539,6 @@ For the global channel, the name will be null.</p>
514
539
 
515
540
 
516
541
 
517
- <div class="description usertext">
518
- <p>Fetches the BTTV emotes for this channel.</p>
519
- </div>
520
-
521
-
522
-
523
542
 
524
543
 
525
544
 
@@ -542,7 +561,7 @@ For the global channel, the name will be null.</p>
542
561
 
543
562
 
544
563
 
545
- <h5>Returns:</h5>
564
+ <h5 class="h5-returns">Returns:</h5>
546
565
 
547
566
 
548
567
 
@@ -556,6 +575,7 @@ For the global channel, the name will be null.</p>
556
575
  <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="BTTVEmote.html">BTTVEmote</a>>></span>
557
576
 
558
577
 
578
+
559
579
  </dd>
560
580
  </dl>
561
581
 
@@ -576,6 +596,10 @@ For the global channel, the name will be null.</p>
576
596
 
577
597
 
578
598
  <dl class="details">
599
+
600
+ <dt class="tag-description">Description:</dt>
601
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the FFZ emotes for this channel.</p></li></ul></dd>
602
+
579
603
 
580
604
 
581
605
  <dt class="tag-source">Source:</dt>
@@ -619,9 +643,6 @@ For the global channel, the name will be null.</p>
619
643
 
620
644
 
621
645
 
622
- <div class="description usertext">
623
- <p>Fetches the FFZ emotes for this channel.</p>
624
- </div>
625
646
 
626
647
 
627
648
 
@@ -643,11 +664,112 @@ For the global channel, the name will be null.</p>
643
664
 
644
665
 
645
666
 
667
+
668
+ <h5 class="h5-returns">Returns:</h5>
669
+
670
+
671
+
672
+
673
+ <dl class="param-type">
674
+ <dt>
675
+ Type
676
+ </dt>
677
+ <dd>
678
+
679
+ <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>></span>
646
680
 
647
681
 
648
682
 
683
+ </dd>
684
+ </dl>
685
+
686
+
687
+
649
688
 
650
- <h5>Returns:</h5>
689
+
690
+
691
+
692
+
693
+
694
+
695
+ <h4 class="name" id="fetchSevenTVEmotes"><span class="type-signature"></span>fetchSevenTVEmotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="SevenTVEmote.html">SevenTVEmote</a>>>}</span></h4>
696
+
697
+
698
+
699
+
700
+
701
+
702
+ <dl class="details">
703
+
704
+ <dt class="tag-description">Description:</dt>
705
+ <dd class="tag-description"><ul class="dummy"><li><p>Fetches the 7TV emotes for this channel.</p></li></ul></dd>
706
+
707
+
708
+
709
+ <dt class="tag-source">Source:</dt>
710
+ <dd class="tag-source"><ul class="dummy"><li>
711
+ <a href="struct_Channel.js.html">struct/Channel.js</a>, <a href="struct_Channel.js.html#line50">line 50</a>
712
+ </li></ul></dd>
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+ </dl>
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+ <h5 class="h5-returns">Returns:</h5>
651
773
 
652
774
 
653
775
 
@@ -658,7 +780,8 @@ For the global channel, the name will be null.</p>
658
780
  </dt>
659
781
  <dd>
660
782
 
661
- <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="FFZEmote.html">FFZEmote</a>>></span>
783
+ <span class="param-type">Promise.&lt;<a href="Collection.html">Collection</a>.&lt;string, <a href="SevenTVEmote.html">SevenTVEmote</a>>></span>
784
+
662
785
 
663
786
 
664
787
  </dd>
@@ -688,7 +811,7 @@ For the global channel, the name will be null.</p>
688
811
  <br class="clear">
689
812
 
690
813
  <footer>
691
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
814
+ 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.
692
815
  </footer>
693
816
 
694
817
  <script>prettyPrint();</script>