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

@mkody/twitch-emoticons 2.7.0 → 2.7.1

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 (43) 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/docs/BTTVEmote.html +1319 -1319
package/docs/Channel.html +823 -823
package/docs/Collection.html +797 -797
package/docs/Emote.html +801 -801
package/docs/EmoteFetcher.html +2946 -2946
package/docs/EmoteParser.html +811 -811
package/docs/FFZEmote.html +1473 -1473
package/docs/SevenTV.html +1190 -1190
package/docs/SevenTVEmote.html +1395 -1395
package/docs/TwitchEmote.html +1315 -1315
package/docs/index.html +206 -206
package/docs/struct_BTTVEmote.js.html +132 -132
package/docs/struct_Channel.js.html +127 -127
package/docs/struct_Emote.js.html +138 -138
package/docs/struct_EmoteFetcher.js.html +395 -399
package/docs/struct_EmoteParser.js.html +153 -153
package/docs/struct_FFZEmote.js.html +146 -146
package/docs/struct_SevenTVEmote.js.html +141 -141
package/docs/struct_TwitchEmote.js.html +130 -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 +60 -60
package/src/struct/Channel.js +55 -55
package/src/struct/Emote.js +66 -66
package/src/struct/EmoteFetcher.js +323 -327
package/src/struct/EmoteParser.js +81 -81
package/src/struct/FFZEmote.js +74 -74
package/src/struct/SevenTVEmote.js +69 -69
package/src/struct/TwitchEmote.js +58 -58
package/src/util/Collection.js +78 -78
package/src/util/Constants.js +31 -31
package/test/index.js +174 -174
package/typings/index.d.ts +98 -98

package/docs/util_Collection.js.html CHANGED Viewed

@@ -1,150 +1,150 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>util/Collection.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">util/Collection.js</h1>
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/**
- * An extended Map with utility methods.
- * @class Collection
- */
-class Collection extends Map {
-    /**
-     * Finds first matching value by property or function.
-     * Same as `Array#find`.
-     * @param {string|Function} propOrFunc - Property or function to test.
-     * @param {any} [value] - Value to find.
-     * @returns {any}
-     */
-    find(propOrFunc, value) {
-        if (typeof propOrFunc === 'string') {
-            if (typeof value === 'undefined') return null;
-            for (const item of this.values()) {
-                if (item[propOrFunc] === value) return item;
-            }
-            return null;
-        }
-        if (typeof propOrFunc === 'function') {
-            let i = 0;
-            for (const item of this.values()) {
-                if (propOrFunc(item, i, this)) return item;
-                i++;
-            }
-            return null;
-        }
-        return null;
-    }
-    /**
-     * Filters cache by function.
-     * Same as `Array#filter`.
-     * @param {Function} func - Function to test.
-     * @param {any} [thisArg] - The context for the function.
-     * @returns {Collection}
-     */
-    filter(func, thisArg) {
-        if (thisArg) func = func.bind(thisArg);
-        const results = new this.constructor();
-        let i = 0;
-        for (const [key, item] of this) {
-            if (func(item, i, this)) results.set(key, item);
-            i++;
-        }
-        return results;
-    }
-    /**
-     * Maps cache by function.
-     * Same as `Array#map`.
-     * @param {Function} func - Function to use.
-     * @param {any} [thisArg] - The context for the function.
-     * @returns {any[]}
-     */
-    map(func, thisArg) {
-        if (thisArg) func = func.bind(thisArg);
-        const array = new Array(this.size);
-        let i = 0;
-        for (const item of this.values()) {
-            array[i] = func(item, i, this);
-            i++;
-        }
-        return array;
-    }
-}
-module.exports = Collection;
-</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>util/Collection.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">util/Collection.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * An extended Map with utility methods.
+ * @class Collection
+ */
+class Collection extends Map {
+    /**
+     * Finds first matching value by property or function.
+     * Same as `Array#find`.
+     * @param {string|Function} propOrFunc - Property or function to test.
+     * @param {any} [value] - Value to find.
+     * @returns {any}
+     */
+    find(propOrFunc, value) {
+        if (typeof propOrFunc === 'string') {
+            if (typeof value === 'undefined') return null;
+            for (const item of this.values()) {
+                if (item[propOrFunc] === value) return item;
+            }
+            return null;
+        }
+        if (typeof propOrFunc === 'function') {
+            let i = 0;
+            for (const item of this.values()) {
+                if (propOrFunc(item, i, this)) return item;
+                i++;
+            }
+            return null;
+        }
+        return null;
+    }
+    /**
+     * Filters cache by function.
+     * Same as `Array#filter`.
+     * @param {Function} func - Function to test.
+     * @param {any} [thisArg] - The context for the function.
+     * @returns {Collection}
+     */
+    filter(func, thisArg) {
+        if (thisArg) func = func.bind(thisArg);
+        const results = new this.constructor();
+        let i = 0;
+        for (const [key, item] of this) {
+            if (func(item, i, this)) results.set(key, item);
+            i++;
+        }
+        return results;
+    }
+    /**
+     * Maps cache by function.
+     * Same as `Array#map`.
+     * @param {Function} func - Function to use.
+     * @param {any} [thisArg] - The context for the function.
+     * @returns {any[]}
+     */
+    map(func, thisArg) {
+        if (thisArg) func = func.bind(thisArg);
+        const array = new Array(this.size);
+        let i = 0;
+        for (const item of this.values()) {
+            array[i] = func(item, i, this);
+            i++;
+        }
+        return array;
+    }
+}
+module.exports = Collection;
+</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>

package/package.json CHANGED Viewed

@@ -1,57 +1,57 @@
-{
-    "name": "@mkody/twitch-emoticons",
-    "version": "2.7.0",
-    "description": "Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!",
-    "main": "src/index.js",
-    "typings": "typings/index.d.ts",
-    "keywords": [
-        "7tv",
-        "bettertwitchtv",
-        "bttv",
-        "emotes",
-        "emoticons",
-        "ffz",
-        "frankerfacez",
-        "parse",
-        "seventv",
-        "twitch-api",
-        "twitch"
-    ],
-    "author": "MKody <gh@kdy.ch> (André Fernandes)",
-    "contrubutors": [
-        "1Computer",
-        "Killusions",
-        "MKody"
-    ],
-    "license": "MIT",
-    "dependencies": {
-        "@twurple/api": "^6.0.9",
-        "@twurple/auth": "^6.0.9",
-        "got": "^11.8.6"
-    },
-    "devDependencies": {
-        "docdash": "^2.0.1",
-        "eslint": "^8.36.0",
-        "jsdoc": "^4.0.2"
-    },
-    "scripts": {
-        "docs": "jsdoc --configure .jsdoc.json --verbose",
-        "test": "node test/index.js",
-        "lint": "eslint ./src ./test"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mkody/twitch-emoticons.git"
-    },
-    "bugs": {
-        "url": "https://github.com/mkody/twitch-emoticons/issues"
-    },
-    "homepage": "https://github.com/mkody/twitch-emoticons",
-    "directories": {
-        "doc": "docs",
-        "test": "test"
-    },
-    "engines" : {
-        "node" : ">=16.0.0"
-    }
-}
+{
+    "name": "@mkody/twitch-emoticons",
+    "version": "2.7.1",
+    "description": "Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!",
+    "main": "src/index.js",
+    "typings": "typings/index.d.ts",
+    "keywords": [
+        "7tv",
+        "bettertwitchtv",
+        "bttv",
+        "emotes",
+        "emoticons",
+        "ffz",
+        "frankerfacez",
+        "parse",
+        "seventv",
+        "twitch-api",
+        "twitch"
+    ],
+    "author": "MKody <gh@kdy.ch> (André Fernandes)",
+    "contrubutors": [
+        "1Computer",
+        "Killusions",
+        "MKody"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "@twurple/api": "^6.2.1",
+        "@twurple/auth": "^6.2.1",
+        "axios": "^1.4.0"
+    },
+    "devDependencies": {
+        "docdash": "^2.0.1",
+        "eslint": "^8.41.0",
+        "jsdoc": "^4.0.2"
+    },
+    "scripts": {
+        "docs": "jsdoc --configure .jsdoc.json --verbose",
+        "test": "node test/index.js",
+        "lint": "eslint ./src ./test"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mkody/twitch-emoticons.git"
+    },
+    "bugs": {
+        "url": "https://github.com/mkody/twitch-emoticons/issues"
+    },
+    "homepage": "https://github.com/mkody/twitch-emoticons",
+    "directories": {
+        "doc": "docs",
+        "test": "test"
+    },
+    "engines": {
+        "node": ">=16.0.0"
+    }
+}

package/src/index.js CHANGED Viewed

@@ -1,12 +1,12 @@
-module.exports = {
-    BTTVEmote: require('./struct/BTTVEmote'),
-    Channel: require('./struct/Channel'),
-    Collection: require('./util/Collection'),
-    Constants: require('./util/Constants'),
-    Emote: require('./struct/Emote'),
-    EmoteFetcher: require('./struct/EmoteFetcher'),
-    EmoteParser: require('./struct/EmoteParser'),
-    FFZEmote: require('./struct/FFZEmote'),
-    SevenTVEmote: require('./struct/SevenTVEmote'),
-    TwitchEmote: require('./struct/TwitchEmote')
-};
+module.exports = {
+    BTTVEmote: require('./struct/BTTVEmote'),
+    Channel: require('./struct/Channel'),
+    Collection: require('./util/Collection'),
+    Constants: require('./util/Constants'),
+    Emote: require('./struct/Emote'),
+    EmoteFetcher: require('./struct/EmoteFetcher'),
+    EmoteParser: require('./struct/EmoteParser'),
+    FFZEmote: require('./struct/FFZEmote'),
+    SevenTVEmote: require('./struct/SevenTVEmote'),
+    TwitchEmote: require('./struct/TwitchEmote')
+};

package/src/struct/BTTVEmote.js CHANGED Viewed

@@ -1,60 +1,60 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
-/** @extends Emote */
-class BTTVEmote extends Emote {
-    /**
-     * A BTTV emote.
-     * @param {Channel} channel - Channel this emote belongs to.
-     * @param {string} id - ID of the emote.
-     * @param {data} data - The raw emote data.
-     */
-    constructor(channel, id, data) {
-        super(channel, id, data);
-        this.type = 'bttv';
-    }
-    /**
-     * The channel of this emote's creator.
-     * Not guaranteed to contain the emote, or be cached.
-     * @readonly
-     * @type {?Channel}
-     */
-    get owner() {
-        return this.fetcher.channels.get(this.ownerName);
-    }
-    _setup(data) {
-        super._setup(data);
-        /**
-         * The name of the emote creator's channel.
-         * Will be null for global or channel emotes.
-         * @type {?string}
-         */
-        this.ownerName = 'user' in data ? data.user.name : null;
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = data.animated;
-        /**
-         * The image type of the emote.
-         * @type {string}
-         */
-        this.imageType = 'webp';
-    }
-    /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image, 0, 1, or 2.
-     * @returns {string}
-     */
-    toLink(size = 0) {
-        return Constants.BTTV.CDN(this.id, size); // eslint-disable-line new-cap
-    }
-}
-module.exports = BTTVEmote;
+const Emote = require('./Emote');
+const Constants = require('../util/Constants');
+/** @extends Emote */
+class BTTVEmote extends Emote {
+    /**
+     * A BTTV emote.
+     * @param {Channel} channel - Channel this emote belongs to.
+     * @param {string} id - ID of the emote.
+     * @param {data} data - The raw emote data.
+     */
+    constructor(channel, id, data) {
+        super(channel, id, data);
+        this.type = 'bttv';
+    }
+    /**
+     * The channel of this emote's creator.
+     * Not guaranteed to contain the emote, or be cached.
+     * @readonly
+     * @type {?Channel}
+     */
+    get owner() {
+        return this.fetcher.channels.get(this.ownerName);
+    }
+    _setup(data) {
+        super._setup(data);
+        /**
+         * The name of the emote creator's channel.
+         * Will be null for global or channel emotes.
+         * @type {?string}
+         */
+        this.ownerName = 'user' in data ? data.user.name : null;
+        /**
+         * If emote is animated.
+         * @type {boolean}
+         */
+        this.animated = data.animated;
+        /**
+         * The image type of the emote.
+         * @type {string}
+         */
+        this.imageType = 'webp';
+    }
+    /**
+     * Gets the image link of the emote.
+     * @param {number} size - The size of the image, 0, 1, or 2.
+     * @returns {string}
+     */
+    toLink(size = 0) {
+        return Constants.BTTV.CDN(this.id, size); // eslint-disable-line new-cap
+    }
+}
+module.exports = BTTVEmote;