@mkody/twitch-emoticons 2.9.3 → 2.9.5
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 +12 -5
- package/.nvmrc +1 -1
- package/dist/TwitchEmoticons.min.js +11 -11
- package/dist/TwitchEmoticons.min.js.map +4 -4
- package/docs/BTTVEmote.html +72 -72
- package/docs/Channel.html +19 -19
- package/docs/Collection.html +25 -25
- package/docs/Emote.html +63 -33
- package/docs/EmoteFetcher.html +426 -366
- package/docs/EmoteParser.html +378 -3
- package/docs/FFZEmote.html +82 -82
- package/docs/SevenTVEmote.html +77 -77
- package/docs/TwitchEmote.html +68 -68
- package/docs/index.html +3 -3
- package/docs/struct_BTTVEmote.js.html +2 -2
- package/docs/struct_Channel.js.html +2 -2
- package/docs/struct_Emote.js.html +3 -2
- package/docs/struct_EmoteFetcher.js.html +4 -2
- package/docs/struct_EmoteParser.js.html +22 -3
- package/docs/struct_FFZEmote.js.html +2 -2
- package/docs/struct_SevenTVEmote.js.html +2 -2
- package/docs/struct_TwitchEmote.js.html +2 -2
- package/docs/util_Collection.js.html +4 -3
- package/package.json +14 -14
- package/src/struct/Emote.js +1 -0
- package/src/struct/EmoteFetcher.js +2 -0
- package/src/struct/EmoteParser.js +20 -1
- package/src/util/Collection.js +1 -0
- package/test/SevenTV.test.js +4 -4
- package/test/__snapshots__/ToFromObject.test.js.snap +1 -1
- package/test/other.test.js +60 -1
- package/typings/index.d.ts +4 -4
- package/docs/SevenTV.html +0 -1191
package/docs/Emote.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#toObject">toObject</a></li><li data-type='method'><a href="BTTVEmote.html#.fromObject">fromObject</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="
|
|
32
|
+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/mkody/twitch-emoticons" target="_blank" class="menu-item" id="github_link" >GitHub</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#toObject">toObject</a></li><li data-type='method'><a href="BTTVEmote.html#.fromObject">fromObject</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="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toObject">toObject</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</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#fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="FFZEmote.html#.fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="SevenTVEmote.html#.fromObject">fromObject</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#toObject">toObject</a></li><li data-type='method'><a href="TwitchEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li></ul>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -81,7 +81,7 @@ This constructor is not to be used.</p></li></ul></dd>
|
|
|
81
81
|
|
|
82
82
|
<dt class="tag-source">Source:</dt>
|
|
83
83
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
84
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
84
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line10">line 10</a>
|
|
85
85
|
</li></ul></dd>
|
|
86
86
|
|
|
87
87
|
|
|
@@ -238,6 +238,36 @@ This constructor is not to be used.</p></li></ul></dd>
|
|
|
238
238
|
|
|
239
239
|
|
|
240
240
|
|
|
241
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<dl>
|
|
246
|
+
<dt>
|
|
247
|
+
<div class="param-desc usertext">
|
|
248
|
+
<p>When trying to use the base Emote class directly.</p>
|
|
249
|
+
</div>
|
|
250
|
+
</dt>
|
|
251
|
+
<dd></dd>
|
|
252
|
+
<dt>
|
|
253
|
+
<dl class="param-type">
|
|
254
|
+
<dt>
|
|
255
|
+
Type
|
|
256
|
+
</dt>
|
|
257
|
+
<dd>
|
|
258
|
+
|
|
259
|
+
<span class="param-type">Error</span>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</dd>
|
|
264
|
+
</dl>
|
|
265
|
+
</dt>
|
|
266
|
+
<dd></dd>
|
|
267
|
+
</dl>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
241
271
|
|
|
242
272
|
|
|
243
273
|
|
|
@@ -264,7 +294,7 @@ This constructor is not to be used.</p></li></ul></dd>
|
|
|
264
294
|
|
|
265
295
|
|
|
266
296
|
|
|
267
|
-
<h4 class="name" id="
|
|
297
|
+
<h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
|
|
268
298
|
|
|
269
299
|
|
|
270
300
|
|
|
@@ -273,15 +303,13 @@ This constructor is not to be used.</p></li></ul></dd>
|
|
|
273
303
|
<dl class="details">
|
|
274
304
|
|
|
275
305
|
<dt class="tag-description">Description:</dt>
|
|
276
|
-
<dd class="tag-description"><ul class="dummy"><li><p>The
|
|
277
|
-
Only accurate and constant on Twitch emotes.<br>
|
|
278
|
-
For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
|
|
306
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
|
|
279
307
|
|
|
280
308
|
|
|
281
309
|
|
|
282
310
|
<dt class="tag-source">Source:</dt>
|
|
283
311
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
284
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
312
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line19">line 19</a>
|
|
285
313
|
</li></ul></dd>
|
|
286
314
|
|
|
287
315
|
|
|
@@ -321,9 +349,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
321
349
|
|
|
322
350
|
|
|
323
351
|
<div class="description usertext">
|
|
324
|
-
<p>The
|
|
325
|
-
Only accurate and constant on Twitch emotes.<br>
|
|
326
|
-
For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
|
|
352
|
+
<p>The emote fetcher.</p>
|
|
327
353
|
</div>
|
|
328
354
|
|
|
329
355
|
|
|
@@ -332,7 +358,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
332
358
|
<ul>
|
|
333
359
|
<li>
|
|
334
360
|
|
|
335
|
-
<span class="param-type"><a href="
|
|
361
|
+
<span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
|
|
336
362
|
|
|
337
363
|
|
|
338
364
|
|
|
@@ -346,7 +372,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
346
372
|
|
|
347
373
|
|
|
348
374
|
|
|
349
|
-
<h4 class="name" id="
|
|
375
|
+
<h4 class="name" id="channel"><span class="type-signature"></span>channel<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
|
|
350
376
|
|
|
351
377
|
|
|
352
378
|
|
|
@@ -355,13 +381,15 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
355
381
|
<dl class="details">
|
|
356
382
|
|
|
357
383
|
<dt class="tag-description">Description:</dt>
|
|
358
|
-
<dd class="tag-description"><ul class="dummy"><li><p>The
|
|
384
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The channel this emote belongs to.<br>
|
|
385
|
+
Only accurate and constant on Twitch emotes.<br>
|
|
386
|
+
For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
|
|
359
387
|
|
|
360
388
|
|
|
361
389
|
|
|
362
390
|
<dt class="tag-source">Source:</dt>
|
|
363
391
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
364
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
392
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line27">line 27</a>
|
|
365
393
|
</li></ul></dd>
|
|
366
394
|
|
|
367
395
|
|
|
@@ -401,7 +429,9 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
401
429
|
|
|
402
430
|
|
|
403
431
|
<div class="description usertext">
|
|
404
|
-
<p>The
|
|
432
|
+
<p>The channel this emote belongs to.<br>
|
|
433
|
+
Only accurate and constant on Twitch emotes.<br>
|
|
434
|
+
For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p>
|
|
405
435
|
</div>
|
|
406
436
|
|
|
407
437
|
|
|
@@ -410,7 +440,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
410
440
|
<ul>
|
|
411
441
|
<li>
|
|
412
442
|
|
|
413
|
-
<span class="param-type">
|
|
443
|
+
<span class="param-type"><a href="Channel.html">Channel</a></span>
|
|
414
444
|
|
|
415
445
|
|
|
416
446
|
|
|
@@ -424,7 +454,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
424
454
|
|
|
425
455
|
|
|
426
456
|
|
|
427
|
-
<h4 class="name" id="
|
|
457
|
+
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
|
|
428
458
|
|
|
429
459
|
|
|
430
460
|
|
|
@@ -433,13 +463,13 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
433
463
|
<dl class="details">
|
|
434
464
|
|
|
435
465
|
<dt class="tag-description">Description:</dt>
|
|
436
|
-
<dd class="tag-description"><ul class="dummy"><li><p>The emote
|
|
466
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
|
|
437
467
|
|
|
438
468
|
|
|
439
469
|
|
|
440
470
|
<dt class="tag-source">Source:</dt>
|
|
441
471
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
442
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
472
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line33">line 33</a>
|
|
443
473
|
</li></ul></dd>
|
|
444
474
|
|
|
445
475
|
|
|
@@ -479,7 +509,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
479
509
|
|
|
480
510
|
|
|
481
511
|
<div class="description usertext">
|
|
482
|
-
<p>The emote
|
|
512
|
+
<p>The ID of this emote.</p>
|
|
483
513
|
</div>
|
|
484
514
|
|
|
485
515
|
|
|
@@ -488,7 +518,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
488
518
|
<ul>
|
|
489
519
|
<li>
|
|
490
520
|
|
|
491
|
-
<span class="param-type"
|
|
521
|
+
<span class="param-type">string</span>
|
|
492
522
|
|
|
493
523
|
|
|
494
524
|
|
|
@@ -502,7 +532,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
502
532
|
|
|
503
533
|
|
|
504
534
|
|
|
505
|
-
<h4 class="name" id="
|
|
535
|
+
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
|
|
506
536
|
|
|
507
537
|
|
|
508
538
|
|
|
@@ -511,13 +541,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
511
541
|
<dl class="details">
|
|
512
542
|
|
|
513
543
|
<dt class="tag-description">Description:</dt>
|
|
514
|
-
<dd class="tag-description"><ul class="dummy"><li><p>The
|
|
544
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
|
|
545
|
+
Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
|
|
515
546
|
|
|
516
547
|
|
|
517
548
|
|
|
518
549
|
<dt class="tag-source">Source:</dt>
|
|
519
550
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
520
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
551
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line40">line 40</a>
|
|
521
552
|
</li></ul></dd>
|
|
522
553
|
|
|
523
554
|
|
|
@@ -557,7 +588,8 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
557
588
|
|
|
558
589
|
|
|
559
590
|
<div class="description usertext">
|
|
560
|
-
<p>The
|
|
591
|
+
<p>The type of this emote.<br>
|
|
592
|
+
Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
561
593
|
</div>
|
|
562
594
|
|
|
563
595
|
|
|
@@ -580,7 +612,7 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
580
612
|
|
|
581
613
|
|
|
582
614
|
|
|
583
|
-
<h4 class="name" id="
|
|
615
|
+
<h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
|
|
584
616
|
|
|
585
617
|
|
|
586
618
|
|
|
@@ -589,14 +621,13 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
|
|
|
589
621
|
<dl class="details">
|
|
590
622
|
|
|
591
623
|
<dt class="tag-description">Description:</dt>
|
|
592
|
-
<dd class="tag-description"><ul class="dummy"><li><p>The
|
|
593
|
-
Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
|
|
624
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
|
|
594
625
|
|
|
595
626
|
|
|
596
627
|
|
|
597
628
|
<dt class="tag-source">Source:</dt>
|
|
598
629
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
599
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
630
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line50">line 50</a>
|
|
600
631
|
</li></ul></dd>
|
|
601
632
|
|
|
602
633
|
|
|
@@ -636,8 +667,7 @@ Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></
|
|
|
636
667
|
|
|
637
668
|
|
|
638
669
|
<div class="description usertext">
|
|
639
|
-
<p>The
|
|
640
|
-
Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
|
|
670
|
+
<p>The code or name of the emote.</p>
|
|
641
671
|
</div>
|
|
642
672
|
|
|
643
673
|
|
|
@@ -686,7 +716,7 @@ Will result in an Object representation of an Emote</p></li></ul></dd>
|
|
|
686
716
|
|
|
687
717
|
<dt class="tag-source">Source:</dt>
|
|
688
718
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
689
|
-
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#
|
|
719
|
+
<a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line78">line 78</a>
|
|
690
720
|
</li></ul></dd>
|
|
691
721
|
|
|
692
722
|
|
|
@@ -789,7 +819,7 @@ Will result in an Object representation of an Emote</p></li></ul></dd>
|
|
|
789
819
|
<br class="clear">
|
|
790
820
|
|
|
791
821
|
<footer>
|
|
792
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
822
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
793
823
|
</footer>
|
|
794
824
|
|
|
795
825
|
<script>prettyPrint();</script>
|