npm - @mkody/twitch-emoticons - Versions diffs - 2.7.0 → 2.8.0 - Mend

@mkody/twitch-emoticons 2.7.0 → 2.8.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.

Files changed (45) hide show

package/.eslintrc.json +143 -143
package/.github/codeql/codeql-config.yml +4 -4
package/.github/workflows/codeql.yml +50 -50
package/.github/workflows/eslint.yml +50 -50
package/.github/workflows/release.yml +22 -0
package/.github/workflows/yarn-test.yml +17 -17
package/.jsdoc.json +39 -39
package/.nvmrc +1 -0
package/LICENSE +22 -22
package/README.md +36 -4
package/docs/BTTVEmote.html +1641 -1319
package/docs/Channel.html +823 -823
package/docs/Collection.html +797 -797
package/docs/Emote.html +906 -801
package/docs/EmoteFetcher.html +3680 -2946
package/docs/EmoteParser.html +811 -811
package/docs/FFZEmote.html +1795 -1473
package/docs/SevenTV.html +1190 -1190
package/docs/SevenTVEmote.html +1705 -1395
package/docs/TwitchEmote.html +1637 -1315
package/docs/index.html +230 -206
package/docs/struct_BTTVEmote.js.html +162 -132
package/docs/struct_Channel.js.html +127 -127
package/docs/struct_Emote.js.html +151 -138
package/docs/struct_EmoteFetcher.js.html +427 -399
package/docs/struct_EmoteParser.js.html +153 -153
package/docs/struct_FFZEmote.js.html +185 -146
package/docs/struct_SevenTVEmote.js.html +178 -141
package/docs/struct_TwitchEmote.js.html +159 -130
package/docs/util_Collection.js.html +150 -150
package/package.json +57 -57
package/src/index.js +12 -12
package/src/struct/BTTVEmote.js +90 -60
package/src/struct/Channel.js +55 -55
package/src/struct/Emote.js +79 -66
package/src/struct/EmoteFetcher.js +355 -327
package/src/struct/EmoteParser.js +81 -81
package/src/struct/EmoteTypeMapper.js +13 -0
package/src/struct/FFZEmote.js +113 -74
package/src/struct/SevenTVEmote.js +106 -69
package/src/struct/TwitchEmote.js +87 -58
package/src/util/Collection.js +78 -78
package/src/util/Constants.js +31 -31
package/test/index.js +482 -174
package/typings/index.d.ts +115 -98

package/docs/struct_EmoteFetcher.js.html CHANGED Viewed

@@ -1,399 +1,427 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>struct/EmoteFetcher.js - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
-    <script src="scripts/nav.js" defer></script>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav >
-    <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>
-</nav>
-<div id="main">
-    <h1 class="page-title">struct/EmoteFetcher.js</h1>
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>const BTTVEmote = require('./BTTVEmote');
-const Channel = require('./Channel');
-const Collection = require('../util/Collection');
-const Constants = require('../util/Constants');
-const FFZEmote = require('./FFZEmote');
-const SevenTVEmote = require('./SevenTVEmote');
-const got = require('got');
-const TwitchEmote = require('./TwitchEmote');
-const { ApiClient } = require('@twurple/api');
-const { AppTokenAuthProvider } = require('@twurple/auth');
-const options = {
-    responseType: 'json'
-};
-class EmoteFetcher {
-    /**
-     * Fetches and caches emotes.
-     * @param {string} clientId The client id for the twitch api.
-     * @param {string} clientSecret The client secret for the twitch api.
-     */
-    constructor(clientId, clientSecret) {
-        if (clientId !== undefined &amp;&amp; clientSecret !== undefined) {
-            const authProvider = new AppTokenAuthProvider(clientId, clientSecret);
-            /**
-             * Twitch api client.
-             */
-            this.apiClient = new ApiClient({ authProvider });
-        }
-        /**
-         * Cached emotes.
-         * Collectionped by emote code to Emote instance.
-         * @type {Collection&lt;string, Emote>}
-         */
-        this.emotes = new Collection();
-        /**
-         * Cached channels.
-         * Collectionped by name to Channel instance.
-         * @type {Collection&lt;string, Channel>}
-         */
-        this.channels = new Collection();
-        /**
-         * Save if we fetched FFZ's modifier emotes once.
-         * @type {boolean}
-         */
-        this.ffzModifiersFetched = false;
-    }
-    /**
-     * The global channel for Twitch, BTTV and 7TV.
-     * @readonly
-     * @type {?Channel}
-     */
-    get globalChannel() {
-        return this.channels.get(null);
-    }
-    /**
-     * Gets the raw Twitch emotes data for a channel.
-     * @private
-     * @param {int} id - ID of the channel.
-     * @returns {Promise&lt;Object[]>}
-     */
-    _getRawTwitchEmotes(id) {
-        if (!this.apiClient) {
-            throw new Error('Client id or client secret not provided.');
-        }
-        if (id) {
-            return this.apiClient.chat.getChannelEmotes(id);
-        } else {
-            return this.apiClient.chat.getGlobalEmotes();
-        }
-    }
-    /**
-     * Converts and caches a raw twitch emote.
-     * @private
-     * @param {int} channel_id - ID of the channel.
-     * @param {Object} data - Raw data.
-     * @returns {TwitchEmote}
-     */
-    _cacheTwitchEmote(channel_id, data) {
-        let channel = this.channels.get(channel_id);
-        if (!channel) {
-            channel = new Channel(this, channel_id);
-            this.channels.set(channel_id, channel);
-        }
-        const emote = new TwitchEmote(channel, data.id, data);
-        this.emotes.set(emote.code, emote);
-        channel.emotes.set(emote.code, emote);
-        return emote;
-    }
-    /**
-     * Gets the raw BTTV emotes data for a channel.
-     * Use `null` for the global emotes channel.
-     * @private
-     * @param {int} [id=null] - ID of the channel.
-     * @returns {Promise&lt;Object[]>}
-     */
-    _getRawBTTVEmotes(id) {
-        const endpoint = !id
-            ? Constants.BTTV.Global
-            : Constants.BTTV.Channel(id); // eslint-disable-line new-cap
-        return got(endpoint, options).then(req => {
-            // Global emotes
-            if (req.body instanceof Array) return req.body;
-            // Channel emotes
-            return [...req.body.channelEmotes, ...req.body.sharedEmotes];
-        });
-    }
-    /**
-     * Converts and caches a raw BTTV emote.
-     * @private
-     * @param {int} channel_id - ID of the channel.
-     * @param {Object} data - Raw data.
-     * @returns {BTTVEmote}
-     */
-    _cacheBTTVEmote(channel_id, data) {
-        let channel = this.channels.get(channel_id);
-        if (!channel) {
-            channel = new Channel(this, channel_id);
-            this.channels.set(channel_id, channel);
-        }
-        const emote = new BTTVEmote(channel, data.id, data);
-        this.emotes.set(emote.code, emote);
-        channel.emotes.set(emote.code, emote);
-        return emote;
-    }
-    /**
-     * Gets the raw FFZ emote data from a set.
-     * @private
-     * @param {int} id - ID of the set.
-     * @returns {Promise&lt;Object[]>}
-     */
-    _getRawFFZEmoteSet(id) {
-        const endpoint = Constants.FFZ.Set(id); // eslint-disable-line new-cap
-        return got(endpoint, options).then(req => {
-            return req.body.set.emoticons;
-        });
-    }
-    /**
-     * Gets the raw FFZ emotes data for a channel.
-     * @private
-     * @param {int} id - ID of the channel.
-     * @returns {Promise&lt;Object[]>}
-     */
-    _getRawFFZEmotes(id) {
-        const endpoint = Constants.FFZ.Channel(id); // eslint-disable-line new-cap
-        return got(endpoint, options).then(req => {
-            const emotes = [];
-            for (const key of Object.keys(req.body.sets)) {
-                const set = req.body.sets[key];
-                emotes.push(...set.emoticons);
-            }
-            return emotes;
-        });
-    }
-    /**
-     * Converts and caches a raw FFZ emote.
-     * @private
-     * @param {int} channel_id - ID of the channel.
-     * @param {Object} data - Raw data.
-     * @returns {FFZEmote}
-     */
-    _cacheFFZEmote(channel_id, data) {
-        let channel = this.channels.get(channel_id);
-        if (!channel) {
-            channel = new Channel(this, channel_id);
-            this.channels.set(channel_id, channel);
-        }
-        const emote = new FFZEmote(channel, data.id, data);
-        this.emotes.set(emote.code, emote);
-        channel.emotes.set(emote.code, emote);
-        return emote;
-    }
-    /**
-     * Gets the raw 7TV emotes data for a channel.
-     * @private
-     * @param {int} [id=null] - ID of the channel.
-     * @returns {Promise&lt;Object[]>}
-     */
-    _getRawSevenTVEmotes(id) {
-        const endpoint = !id
-            ? Constants.SevenTV.Global
-            : Constants.SevenTV.Channel(id); // eslint-disable-line new-cap
-        return got(endpoint, options).then(req => req.body);
-    }
-    /**
-     * Converts and caches a raw 7TV emote.
-     * @private
-     * @param {int} channel_id - ID of the channel.
-     * @param {Object} data - Raw data.
-     * @param {string} format - The type file format to use (webp/avif).
-     * @returns {SevenTVEmote}
-     */
-    _cacheSevenTVEmote(channel_id, data, format) {
-        let channel = this.channels.get(channel_id);
-        if (!channel) {
-            channel = new Channel(this, channel_id);
-            this.channels.set(channel_id, channel);
-        }
-        channel.format = format;
-        const emote = new SevenTVEmote(channel, data.id, data);
-        this.emotes.set(emote.code, emote);
-        channel.emotes.set(emote.code, emote);
-        return emote;
-    }
-    /**
-     * Fetches the Twitch emotes for a channel.
-     * Use `null` for the global emotes channel.
-     * @param {int} [channel=null] - ID of the channel.
-     * @returns {Promise&lt;Collection&lt;string, TwitchEmote>>}
-     */
-    fetchTwitchEmotes(channel = null) {
-        return this._getRawTwitchEmotes(channel).then(rawEmotes => {
-            for (const emote of rawEmotes) {
-                this._cacheTwitchEmote(channel, {
-                    code: emote.name, id: emote.id, formats: emote.formats
-                });
-            }
-            return this.channels.get(channel).emotes.filter(e => e.type === 'twitch');
-        });
-    }
-    /**
-     * Fetches the BTTV emotes for a channel.
-     * Use `null` for the global emotes channel.
-     * @param {int} [channel=null] - ID of the channel.
-     * @returns {Promise&lt;Collection&lt;string, BTTVEmote>>}
-     */
-    fetchBTTVEmotes(channel = null) {
-        return this._getRawBTTVEmotes(channel).then(rawEmotes => {
-            for (const data of rawEmotes) {
-                this._cacheBTTVEmote(channel, data);
-            }
-            return this.channels.get(channel).emotes.filter(e => e.type === 'bttv');
-        });
-    }
-    /**
-     * Fetches the FFZ emotes for a channel.
-     * @param {int} [channel=null] - ID of the channel.
-     * @returns {Promise&lt;Collection&lt;string, FFZEmote>>}
-     */
-    async fetchFFZEmotes(channel) {
-        // Fetch modifier emotes at least once
-        if (!this.ffzModifiersFetched) {
-            this.ffzModifiersFetched = true;
-            await this._getRawFFZEmoteSet(Constants.FFZ.sets.Modifiers).then(rawEmotes => {
-                for (const data of rawEmotes) {
-                    this._cacheFFZEmote(null, data);
-                }
-            });
-        }
-        // If no channel specified, fetch the Global set
-        if (!channel) {
-            return this._getRawFFZEmoteSet(Constants.FFZ.sets.Global).then(rawEmotes => {
-                for (const data of rawEmotes) {
-                    this._cacheFFZEmote(channel, data);
-                }
-                return this.channels.get(channel).emotes.filter(e => e.type === 'ffz');
-            });
-        }
-        return this._getRawFFZEmotes(channel).then(rawEmotes => {
-            for (const data of rawEmotes) {
-                this._cacheFFZEmote(channel, data);
-            }
-            return this.channels.get(channel).emotes.filter(e => e.type === 'ffz');
-        });
-    }
-    /**
-     * Fetches the 7TV emotes for a channel.
-     * @param {int} [channel=null] - ID of the channel.
-     * @param {('webp'|'avif')} [format='webp'] - The type file format to use (webp/avif).
-     * @returns {Promise&lt;Collection&lt;string, SevenTVEmote>>}
-     */
-    fetchSevenTVEmotes(channel = null, format = 'webp') {
-        return this._getRawSevenTVEmotes(channel).then(rawEmotes => {
-            if ('emotes' in rawEmotes) {
-                // From an emote set (like "global")
-                for (const data of rawEmotes.emotes) {
-                    this._cacheSevenTVEmote(channel, data.data, format);
-                }
-            } else {
-                // From users
-                for (const data of rawEmotes.emote_set.emotes) {
-                    this._cacheSevenTVEmote(channel, data.data, format);
-                }
-            }
-            return this.channels.get(channel).emotes.filter(e => e.type === '7tv');
-        });
-    }
-}
-module.exports = EmoteFetcher;
-</code></pre>
-        </article>
-    </section>
-</div>
-<br class="clear">
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/polyfill.js"></script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>struct/EmoteFetcher.js - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav >
+    <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#toString">toString</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="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#toObject">toObject</a></li><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#_setupChannel">_setupChannel</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><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#toString">toString</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#toString">toString</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#toString">toString</a></li><li data-type='method'><a href="TwitchEmote.html#.fromObject">fromObject</a></li></ul></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">struct/EmoteFetcher.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>const BTTVEmote = require('./BTTVEmote');
+const Channel = require('./Channel');
+const Collection = require('../util/Collection');
+const Constants = require('../util/Constants');
+const FFZEmote = require('./FFZEmote');
+const SevenTVEmote = require('./SevenTVEmote');
+const TwitchEmote = require('./TwitchEmote');
+const axios = require('axios');
+const { ApiClient } = require('@twurple/api');
+const { AppTokenAuthProvider } = require('@twurple/auth');
+class EmoteFetcher {
+    /**
+     * Fetches and caches emotes.
+     * @param {string} clientId The client id for the twitch api.
+     * @param {string} clientSecret The client secret for the twitch api.
+     * @param {Object} options Additional options.
+     * @param {ApiClient} options.apiClient - Bring your own Twurple ApiClient.
+    */
+    constructor(clientId, clientSecret, options) {
+        if (options &amp;&amp; options.apiClient) {
+            this.apiClient = options.apiClient;
+        } else if (clientId !== undefined &amp;&amp; clientSecret !== undefined) {
+            const authProvider = new AppTokenAuthProvider(clientId, clientSecret);
+            /**
+             * Twitch api client.
+             */
+            this.apiClient = new ApiClient({ authProvider });
+        }
+        /**
+         * Cached emotes.
+         * Collectionped by emote code to Emote instance.
+         * @type {Collection&lt;string, Emote>}
+         */
+        this.emotes = new Collection();
+        /**
+         * Cached channels.
+         * Collectionped by name to Channel instance.
+         * @type {Collection&lt;string, Channel>}
+         */
+        this.channels = new Collection();
+        /**
+         * Save if we fetched FFZ's modifier emotes once.
+         * @type {boolean}
+         */
+        this.ffzModifiersFetched = false;
+    }
+    /**
+     * The global channel for Twitch, BTTV and 7TV.
+     * @readonly
+     * @type {?Channel}
+     */
+    get globalChannel() {
+        return this.channels.get(null);
+    }
+    /**
+     * Sets up a channel
+     * @private
+     * @param {int} channel_id - ID of the channel.
+     * @param {string} [format=null] - The type file format to use (webp/avif).
+     * @returns {Channel}
+     */
+    _setupChannel(channel_id, format = null) {
+        let channel = this.channels.get(channel_id);
+        if (!channel) {
+            channel = new Channel(this, channel_id);
+            this.channels.set(channel_id, channel);
+        }
+        if (format) channel.format = format;
+        return channel;
+    }
+    /**
+     * Gets the raw Twitch emotes data for a channel.
+     * @private
+     * @param {int} id - ID of the channel.
+     * @returns {Promise&lt;Object[]>}
+     */
+    _getRawTwitchEmotes(id) {
+        if (!this.apiClient) {
+            throw new Error('Client id or client secret not provided.');
+        }
+        if (id) {
+            return this.apiClient.chat.getChannelEmotes(id);
+        } else {
+            return this.apiClient.chat.getGlobalEmotes();
+        }
+    }
+    /**
+     * Converts and caches a raw twitch emote.
+     * @private
+     * @param {int} channel_id - ID of the channel.
+     * @param {Object} data - Raw data.
+     * @param {TwitchEmote} [existing_emote=null] - Existing emote to cache.
+     * @returns {TwitchEmote}
+     */
+    _cacheTwitchEmote(channel_id, data, existing_emote = null) {
+        const channel = this._setupChannel(channel_id);
+        const emote = existing_emote || new TwitchEmote(channel, data.id, data);
+        this.emotes.set(emote.code, emote);
+        channel.emotes.set(emote.code, emote);
+        return emote;
+    }
+    /**
+     * Gets the raw BTTV emotes data for a channel.
+     * Use `null` for the global emotes channel.
+     * @private
+     * @param {int} [id=null] - ID of the channel.
+     * @returns {Promise&lt;Object[]>}
+     */
+    _getRawBTTVEmotes(id) {
+        const endpoint = !id
+            ? Constants.BTTV.Global
+            : Constants.BTTV.Channel(id); // eslint-disable-line new-cap
+        return axios.get(endpoint).then(req => {
+            // Global emotes
+            if (req.data instanceof Array) return req.data;
+            // Channel emotes
+            return [...req.data.channelEmotes, ...req.data.sharedEmotes];
+        });
+    }
+    /**
+     * Converts and caches a raw BTTV emote.
+     * @private
+     * @param {int} channel_id - ID of the channel.
+     * @param {Object} data - Raw data.
+     * @param {BTTVEmote} [existing_emote=null] - Existing emote to cache.
+     * @returns {BTTVEmote}
+     */
+    _cacheBTTVEmote(channel_id, data, existing_emote = null) {
+        const channel = this._setupChannel(channel_id);
+        const emote = existing_emote || new BTTVEmote(channel, data.id, data);
+        this.emotes.set(emote.code, emote);
+        channel.emotes.set(emote.code, emote);
+        return emote;
+    }
+    /**
+     * Gets the raw FFZ emote data from a set.
+     * @private
+     * @param {int} id - ID of the set.
+     * @returns {Promise&lt;Object[]>}
+     */
+    _getRawFFZEmoteSet(id) {
+        const endpoint = Constants.FFZ.Set(id); // eslint-disable-line new-cap
+        return axios.get(endpoint).then(req => {
+            return req.data.set.emoticons;
+        });
+    }
+    /**
+     * Gets the raw FFZ emotes data for a channel.
+     * @private
+     * @param {int} id - ID of the channel.
+     * @returns {Promise&lt;Object[]>}
+     */
+    _getRawFFZEmotes(id) {
+        const endpoint = Constants.FFZ.Channel(id); // eslint-disable-line new-cap
+        return axios.get(endpoint).then(req => {
+            const emotes = [];
+            for (const key of Object.keys(req.data.sets)) {
+                const set = req.data.sets[key];
+                emotes.push(...set.emoticons);
+            }
+            return emotes;
+        });
+    }
+    /**
+     * Converts and caches a raw FFZ emote.
+     * @private
+     * @param {int} channel_id - ID of the channel.
+     * @param {Object} data - Raw data.
+     * @param {FFZEmote} [existing_emote=null] - Existing emote to cache.
+     * @returns {FFZEmote}
+     */
+    _cacheFFZEmote(channel_id, data, existing_emote = null) {
+        const channel = this._setupChannel(channel_id);
+        const emote = existing_emote || new FFZEmote(channel, data.id, data);
+        this.emotes.set(emote.code, emote);
+        channel.emotes.set(emote.code, emote);
+        return emote;
+    }
+    /**
+     * Gets the raw 7TV emotes data for a channel.
+     * @private
+     * @param {int} [id=null] - ID of the channel.
+     * @returns {Promise&lt;Object[]>}
+     */
+    _getRawSevenTVEmotes(id) {
+        const endpoint = !id
+            ? Constants.SevenTV.Global
+            : Constants.SevenTV.Channel(id); // eslint-disable-line new-cap
+        return axios.get(endpoint).then(req => req.data);
+    }
+    /**
+     * Converts and caches a raw 7TV emote.
+     * @private
+     * @param {int} channel_id - ID of the channel.
+     * @param {Object} data - Raw data.
+     * @param {string} format - The type file format to use (webp/avif).
+     * @param {SevenTVEmote} [existing_emote=null] - Existing emote to cache.
+     * @returns {SevenTVEmote}
+     */
+    _cacheSevenTVEmote(channel_id, data, format, existing_emote = null) {
+        const channel = this._setupChannel(channel_id, format);
+        const emote = existing_emote || new SevenTVEmote(channel, data.id, data);
+        this.emotes.set(emote.code, emote);
+        channel.emotes.set(emote.code, emote);
+        return emote;
+    }
+    /**
+     * Fetches the Twitch emotes for a channel.
+     * Use `null` for the global emotes channel.
+     * @param {int} [channel=null] - ID of the channel.
+     * @returns {Promise&lt;Collection&lt;string, TwitchEmote>>}
+     */
+    fetchTwitchEmotes(channel = null) {
+        return this._getRawTwitchEmotes(channel).then(rawEmotes => {
+            for (const emote of rawEmotes) {
+                this._cacheTwitchEmote(channel, {
+                    code: emote.name, id: emote.id, formats: emote.formats
+                });
+            }
+            return this.channels.get(channel).emotes.filter(e => e.type === 'twitch');
+        });
+    }
+    /**
+     * Fetches the BTTV emotes for a channel.
+     * Use `null` for the global emotes channel.
+     * @param {int} [channel=null] - ID of the channel.
+     * @returns {Promise&lt;Collection&lt;string, BTTVEmote>>}
+     */
+    fetchBTTVEmotes(channel = null) {
+        return this._getRawBTTVEmotes(channel).then(rawEmotes => {
+            for (const data of rawEmotes) {
+                this._cacheBTTVEmote(channel, data);
+            }
+            return this.channels.get(channel).emotes.filter(e => e.type === 'bttv');
+        });
+    }
+    /**
+     * Fetches the FFZ emotes for a channel.
+     * @param {int} [channel=null] - ID of the channel.
+     * @returns {Promise&lt;Collection&lt;string, FFZEmote>>}
+     */
+    async fetchFFZEmotes(channel) {
+        // Fetch modifier emotes at least once
+        if (!this.ffzModifiersFetched) {
+            this.ffzModifiersFetched = true;
+            await this._getRawFFZEmoteSet(Constants.FFZ.sets.Modifiers).then(rawEmotes => {
+                for (const data of rawEmotes) {
+                    this._cacheFFZEmote(null, data);
+                }
+            });
+        }
+        // If no channel specified, fetch the Global set
+        if (!channel) {
+            return this._getRawFFZEmoteSet(Constants.FFZ.sets.Global).then(rawEmotes => {
+                for (const data of rawEmotes) {
+                    this._cacheFFZEmote(channel, data);
+                }
+                return this.channels.get(channel).emotes.filter(e => e.type === 'ffz');
+            });
+        }
+        return this._getRawFFZEmotes(channel).then(rawEmotes => {
+            for (const data of rawEmotes) {
+                this._cacheFFZEmote(channel, data);
+            }
+            return this.channels.get(channel).emotes.filter(e => e.type === 'ffz');
+        });
+    }
+    /**
+     * Fetches the 7TV emotes for a channel.
+     * @param {int} [channel=null] - ID of the channel.
+     * @param {('webp'|'avif')} [format='webp'] - The type file format to use (webp/avif).
+     * @returns {Promise&lt;Collection&lt;string, SevenTVEmote>>}
+     */
+    fetchSevenTVEmotes(channel = null, format = 'webp') {
+        return this._getRawSevenTVEmotes(channel).then(rawEmotes => {
+            if ('emotes' in rawEmotes) {
+                // From an emote set (like "global")
+                for (const data of rawEmotes.emotes) {
+                    this._cacheSevenTVEmote(channel, data.data, format);
+                }
+            } else {
+                // From users
+                for (const data of rawEmotes.emote_set.emotes) {
+                    this._cacheSevenTVEmote(channel, data.data, format);
+                }
+            }
+            return this.channels.get(channel).emotes.filter(e => e.type === '7tv');
+        });
+    }
+    /**
+     * Converts emote Objects to emotes
+     * @param {Object} [json] - Emote Object
+     * @returns {Emote[]}
+     */
+    fromObject(json) {
+        const emotes = [];
+        const classMap = {
+            bttv: { class: BTTVEmote, cache: (emoteObject, channel_id, existing_emote) => this._cacheBTTVEmote(channel_id, null, existing_emote) },
+            ffz: { class: FFZEmote, cache: (emoteObject, channel_id, existing_emote) => this._cacheFFZEmote(channel_id, null, existing_emote) },
+            '7tv': { class: SevenTVEmote, cache: (emoteObject, channel_id, existing_emote) => this._cacheSevenTVEmote(channel_id, null, emoteObject.imageType, existing_emote) },
+            twitch: { class: TwitchEmote, cache: (emoteObject, channel_id, existing_emote) => this._cacheTwitchEmote(channel_id, null, existing_emote) }
+        };
+        for (const emoteObject of json) {
+            const { type } = emoteObject;
+            if (!Object.keys(classMap).includes(type)) {
+                throw new TypeError(`Unknown type: ${type}`);
+            }
+            const emoteClass = classMap[type].class;
+            this._setupChannel(emoteObject.channel_id, type === '7tv' ? emoteObject.imageType : null);
+            const emote = emoteClass.fromObject(emoteObject, this.channels.get(emoteObject.channel_id));
+            classMap[type].cache(emoteObject, emoteObject.channel_id, emote);
+            emotes.push(emote);
+        }
+        return emotes;
+    }
+}
+module.exports = EmoteFetcher;
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>