@mkody/twitch-emoticons 2.9.6 → 3.0.0-beta.2

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 (80) hide show
  1. package/README.md +530 -169
  2. package/dist/TwitchEmoticons.cjs +950 -0
  3. package/dist/TwitchEmoticons.esm.min.js +7 -0
  4. package/dist/TwitchEmoticons.esm.min.js.map +7 -0
  5. package/dist/TwitchEmoticons.min.js +2 -20
  6. package/dist/TwitchEmoticons.min.js.map +4 -4
  7. package/package.json +99 -72
  8. package/src/index.js +38 -12
  9. package/src/struct/BTTVEmote.js +72 -74
  10. package/src/struct/Channel.js +48 -48
  11. package/src/struct/Emote.js +71 -71
  12. package/src/struct/EmoteFetcher.js +358 -322
  13. package/src/struct/EmoteParser.js +95 -84
  14. package/src/struct/EmoteTypeMapper.js +9 -9
  15. package/src/struct/FFZEmote.js +91 -93
  16. package/src/struct/SevenTVEmote.js +88 -90
  17. package/src/struct/TwitchEmote.js +72 -71
  18. package/src/util/Collection.js +69 -55
  19. package/src/util/Constants.js +30 -30
  20. package/typings/index.d.cts +254 -0
  21. package/typings/index.d.ts +216 -99
  22. package/.jsdoc.json +0 -46
  23. package/.nvmrc +0 -1
  24. package/docs/BTTVEmote.html +0 -1532
  25. package/docs/Channel.html +0 -824
  26. package/docs/Collection.html +0 -798
  27. package/docs/Emote.html +0 -832
  28. package/docs/EmoteFetcher.html +0 -3741
  29. package/docs/EmoteParser.html +0 -1187
  30. package/docs/FFZEmote.html +0 -1686
  31. package/docs/SevenTVEmote.html +0 -1596
  32. package/docs/TwitchEmote.html +0 -1528
  33. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  34. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  35. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  36. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  37. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  38. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  39. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  40. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  42. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
  43. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  44. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  45. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  46. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  47. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
  48. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  49. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  50. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  51. package/docs/index.html +0 -233
  52. package/docs/scripts/collapse.js +0 -39
  53. package/docs/scripts/commonNav.js +0 -28
  54. package/docs/scripts/linenumber.js +0 -25
  55. package/docs/scripts/nav.js +0 -12
  56. package/docs/scripts/polyfill.js +0 -4
  57. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  58. package/docs/scripts/prettify/lang-css.js +0 -2
  59. package/docs/scripts/prettify/prettify.js +0 -28
  60. package/docs/scripts/search.js +0 -99
  61. package/docs/struct_BTTVEmote.js.html +0 -162
  62. package/docs/struct_Channel.js.html +0 -132
  63. package/docs/struct_Emote.js.html +0 -159
  64. package/docs/struct_EmoteFetcher.js.html +0 -429
  65. package/docs/struct_EmoteParser.js.html +0 -172
  66. package/docs/struct_FFZEmote.js.html +0 -185
  67. package/docs/struct_SevenTVEmote.js.html +0 -180
  68. package/docs/struct_TwitchEmote.js.html +0 -159
  69. package/docs/styles/jsdoc.css +0 -776
  70. package/docs/styles/prettify.css +0 -80
  71. package/docs/util_Collection.js.html +0 -151
  72. package/eslint.config.mjs +0 -215
  73. package/jest.config.js +0 -198
  74. package/test/BTTV.test.js +0 -48
  75. package/test/FFZ.test.js +0 -71
  76. package/test/SevenTV.test.js +0 -71
  77. package/test/ToFromObject.test.js +0 -156
  78. package/test/Twitch.test.js +0 -64
  79. package/test/__snapshots__/ToFromObject.test.js.snap +0 -121
  80. package/test/other.test.js +0 -72
package/docs/struct_FFZEmote.js.html DELETED
@@ -1,185 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>struct/FFZEmote.js - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
-
18
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
- </head>
20
- <body>
21
-
22
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
- <label for="nav-trigger" class="navicon-button x">
24
- <div class="navicon"></div>
25
- </label>
26
-
27
- <label for="nav-trigger" class="overlay"></label>
28
-
29
- <nav >
30
-
31
-
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
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">struct/FFZEmote.js</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
- <article>
48
- <pre class="prettyprint source linenums"><code>const Emote = require('./Emote');
49
- const Constants = require('../util/Constants');
50
-
51
- /** @augments Emote */
52
- class FFZEmote extends Emote {
53
- /**
54
- * An FFZ emote.
55
- * @param {Channel} channel - Channel this emote belongs to.
56
- * @param {string} id - ID of the emote.
57
- * @param {data} data - The raw emote data.
58
- */
59
- constructor(channel, id, data) {
60
- super(channel, id, data);
61
- this.type = 'ffz';
62
- }
63
-
64
- /**
65
- * The channel of this emote's creator.
66
- * Not guaranteed to contain the emote, or be cached.
67
- * @readonly
68
- * @type {?Channel}
69
- */
70
- get owner() {
71
- return this.fetcher.channels.get(this.ownerName);
72
- }
73
-
74
- _setup(data) {
75
- super._setup(data);
76
- this.code = data.name;
77
-
78
- /**
79
- * The name of the emote creator's channel.
80
- * @type {?string}
81
- */
82
- this.ownerName = 'owner' in data ? data.owner.name : null;
83
-
84
- /**
85
- * Available image sizes.
86
- * @type {string[]}
87
- */
88
- this.sizes = 'animated' in data ? Object.keys(data.animated) : Object.keys(data.urls);
89
-
90
- /**
91
- * If emote is animated.
92
- * @type {boolean}
93
- */
94
- this.animated = 'animated' in data;
95
-
96
- /**
97
- * The image type of the emote.
98
- * @type {string}
99
- */
100
- this.imageType = 'animated' in data ? 'webp' : 'png';
101
-
102
- /**
103
- * If the emote is a modifier and should be hidden.
104
- * @type {boolean}
105
- */
106
- this.modifier = data.modifier &amp;&amp; (data.modifier_flags &amp; 1) !== 0;
107
- }
108
-
109
- /**
110
- * Gets the image link of the emote.
111
- * @param {number} size - The size of the image.
112
- * @returns {string}
113
- */
114
- toLink(size = 0) {
115
- size = this.sizes[size];
116
- if (this.animated) return Constants.FFZ.CDNAnimated(this.id, size); // eslint-disable-line new-cap
117
- return Constants.FFZ.CDN(this.id, size); // eslint-disable-line new-cap
118
- }
119
-
120
- /**
121
- * Override for `toObject`.
122
- * Will result in an Object representation of a FFZEmote
123
- * @returns {object}
124
- */
125
- toObject() {
126
- return Object.assign({}, super.toObject(), {
127
- animated: this.animated,
128
- sizes: this.sizes,
129
- ownerName: this.ownerName,
130
- type: this.type,
131
- modifier: this.modifier
132
- });
133
- }
134
-
135
- /**
136
- * Converts an emote Object into a FFZEmote
137
- * @param {object} [emoteObject] - Object representation of this emote
138
- * @param {Channel} [channel=null] - Channel this emote belongs to.
139
- * @returns {FFZEmote}
140
- */
141
- static fromObject(emoteObject, channel = null) {
142
- // Need to convert sizes array to object, e.g. [1, 2, 4] -> { 1: '1', 2: '2', 4: '4' }
143
- const sizes_obj = emoteObject.sizes.reduce((acc, curr) => {
144
- acc[curr] = curr;
145
- return acc;
146
- }, {});
147
- return new FFZEmote(channel, emoteObject.id,
148
- {
149
- code: emoteObject.code,
150
- name: emoteObject.code,
151
- urls: sizes_obj,
152
- ...emoteObject.animated ? { animated: sizes_obj } : {},
153
- owner: { name: emoteObject.ownerName },
154
- modifier: emoteObject.modifier,
155
- modifier_flags: emoteObject.modifier
156
- });
157
- }
158
- }
159
-
160
- module.exports = FFZEmote;
161
- </code></pre>
162
- </article>
163
- </section>
164
-
165
-
166
-
167
-
168
-
169
-
170
- </div>
171
-
172
- <br class="clear">
173
-
174
- <footer>
175
- 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.
176
- </footer>
177
-
178
- <script>prettyPrint();</script>
179
- <script src="scripts/polyfill.js"></script>
180
- <script src="scripts/linenumber.js"></script>
181
-
182
-
183
-
184
- </body>
185
- </html>
package/docs/struct_SevenTVEmote.js.html DELETED
@@ -1,180 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>struct/SevenTVEmote.js - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
-
18
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
- </head>
20
- <body>
21
-
22
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
- <label for="nav-trigger" class="navicon-button x">
24
- <div class="navicon"></div>
25
- </label>
26
-
27
- <label for="nav-trigger" class="overlay"></label>
28
-
29
- <nav >
30
-
31
-
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
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">struct/SevenTVEmote.js</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
- <article>
48
- <pre class="prettyprint source linenums"><code>const Emote = require('./Emote');
49
- const Constants = require('../util/Constants');
50
-
51
- /** @augments Emote */
52
- class SevenTVEmote extends Emote {
53
- /**
54
- * A 7TV emote.
55
- * @param {Channel} channel - Channel this emote belongs to.
56
- * @param {string} id - ID of the emote.
57
- * @param {data} data - The raw emote data.
58
- */
59
- constructor(channel, id, data) {
60
- super(channel, id, data);
61
- this.type = '7tv';
62
- }
63
-
64
- /**
65
- * The channel of this emote's creator.
66
- * Not guaranteed to contain the emote, or be cached.
67
- * @readonly
68
- * @type {?Channel}
69
- */
70
- get owner() {
71
- return this.fetcher.channels.get(this.ownerName);
72
- }
73
-
74
- _setup(data) {
75
- super._setup(data);
76
- this.code = data.name;
77
-
78
- /**
79
- * The name of the emote creator's channel.
80
- * @type {?string}
81
- */
82
- this.ownerName = 'owner' in data.data ? data.data.owner.display_name : null;
83
-
84
- /**
85
- * Available image sizes.
86
- * @type {string[]}
87
- */
88
- this.sizes = data.data.host.files
89
- .filter(el => el.format === this.channel.format.toUpperCase())
90
- .map(el => el.name);
91
-
92
- /**
93
- * If emote is animated.
94
- * @type {boolean}
95
- */
96
- this.animated = data.data.animated;
97
-
98
- /**
99
- * The image type of the emote.
100
- * @type {string}
101
- */
102
- this.imageType = this.channel.format;
103
- }
104
-
105
- /**
106
- * Gets the image link of the emote.
107
- * @param {number} size - The size of the image.
108
- * @returns {string}
109
- */
110
- toLink(size = 0) {
111
- size = this.sizes[size];
112
- return Constants.SevenTV.CDN(this.id, size); // eslint-disable-line new-cap
113
- }
114
-
115
- /**
116
- * Override for `toObject`.
117
- * Will result in an Object representation of a SevenTVEmote
118
- * @returns {object}
119
- */
120
- toObject() {
121
- return Object.assign({}, super.toObject(), {
122
- animated: this.animated,
123
- sizes: this.sizes,
124
- ownerName: this.ownerName,
125
- type: this.type,
126
- imageType: this.imageType
127
- });
128
- }
129
-
130
- /**
131
- * Converts an emote Object into a SevenTVEmote
132
- * @param {object} [emoteObject] - Object representation of this emote
133
- * @param {Channel} [channel] - Channel this emote belongs to.
134
- * @returns {SevenTVEmote}
135
- */
136
- static fromObject(emoteObject, channel) {
137
- const sizes = emoteObject.sizes.map(size => { return { format: channel.format.toUpperCase(), name: size }; });
138
- return new SevenTVEmote(channel, emoteObject.id,
139
- {
140
- code: emoteObject.code,
141
- name: emoteObject.code,
142
- data: {
143
- animated: emoteObject.animated,
144
- owner: {
145
- display_name: emoteObject.ownerName
146
- },
147
- host: {
148
- files: sizes
149
- }
150
- }
151
- });
152
- }
153
- }
154
-
155
- module.exports = SevenTVEmote;
156
- </code></pre>
157
- </article>
158
- </section>
159
-
160
-
161
-
162
-
163
-
164
-
165
- </div>
166
-
167
- <br class="clear">
168
-
169
- <footer>
170
- 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.
171
- </footer>
172
-
173
- <script>prettyPrint();</script>
174
- <script src="scripts/polyfill.js"></script>
175
- <script src="scripts/linenumber.js"></script>
176
-
177
-
178
-
179
- </body>
180
- </html>
package/docs/struct_TwitchEmote.js.html DELETED
@@ -1,159 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>struct/TwitchEmote.js - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
-
18
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
- </head>
20
- <body>
21
-
22
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
- <label for="nav-trigger" class="navicon-button x">
24
- <div class="navicon"></div>
25
- </label>
26
-
27
- <label for="nav-trigger" class="overlay"></label>
28
-
29
- <nav >
30
-
31
-
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
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">struct/TwitchEmote.js</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
- <article>
48
- <pre class="prettyprint source linenums"><code>const Emote = require('./Emote');
49
- const Constants = require('../util/Constants');
50
-
51
- /** @augments Emote */
52
- class TwitchEmote extends Emote {
53
- /**
54
- * A Twitch emote.
55
- * @param {Channel} channel - Channel this emote belongs to.
56
- * @param {string} id - ID of the emote.
57
- * @param {data} data - The raw emote data.
58
- */
59
- constructor(channel, id, data) {
60
- super(channel, id, data);
61
- this.type = 'twitch';
62
- }
63
-
64
- /**
65
- * The channel of this emote's creator.
66
- * @readonly
67
- * @type {Channel}
68
- */
69
- get owner() {
70
- return this.channel;
71
- }
72
-
73
- _setup(data) {
74
- super._setup(data);
75
-
76
- /**
77
- * The set ID of the emote.
78
- * @type {?string}
79
- */
80
- this.set = data.emoticon_set;
81
-
82
- /**
83
- * If emote is animated.
84
- * @type {boolean}
85
- */
86
- this.animated = 'animated' in data.formats;
87
-
88
- /**
89
- * The image type of the emote.
90
- * @type {string}
91
- */
92
- this.imageType = 'animated' in data.formats ? 'gif' : 'png';
93
- }
94
-
95
- /**
96
- * Gets the image link of the emote.
97
- * @param {number} size - The size of the image, 0, 1, or 2.
98
- * @returns {string}
99
- */
100
- toLink(size = 0) {
101
- return Constants.Twitch.CDN(this.id, size); // eslint-disable-line new-cap
102
- }
103
-
104
- /**
105
- * Override for `toObject`.
106
- * Will result in an Object representation of a TwitchEmote
107
- * @returns {object}
108
- */
109
- toObject() {
110
- return Object.assign({}, super.toObject(), {
111
- animated: this.animated,
112
- set: this.set,
113
- type: this.type
114
- });
115
- }
116
-
117
- /**
118
- * Converts an emote Object into a TwitchEmote
119
- * @param {object} [emoteObject] - Object representation of this emote
120
- * @param {Channel} [channel=null] - Channel this emote belongs to.
121
- * @returns {TwitchEmote}
122
- */
123
- static fromObject(emoteObject, channel = null) {
124
- return new TwitchEmote(channel, emoteObject.id,
125
- {
126
- code: emoteObject.code,
127
- animated: emoteObject.animated,
128
- emoticon_set: emoteObject.set,
129
- formats: emoteObject.animated ? { animated: emoteObject.animated } : {}
130
- });
131
- }
132
- }
133
-
134
- module.exports = TwitchEmote;
135
- </code></pre>
136
- </article>
137
- </section>
138
-
139
-
140
-
141
-
142
-
143
-
144
- </div>
145
-
146
- <br class="clear">
147
-
148
- <footer>
149
- 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.
150
- </footer>
151
-
152
- <script>prettyPrint();</script>
153
- <script src="scripts/polyfill.js"></script>
154
- <script src="scripts/linenumber.js"></script>
155
-
156
-
157
-
158
- </body>
159
- </html>