@mkody/twitch-emoticons 2.4.1 → 2.6.0

package/.jsdoc.json

@@ -30,5 +30,10 @@
     "plugins": ["plugins/markdown"],
     "markdown": {
         "hardwrap": true
+    },
+    "docdash": {
+        "scopeInOutputPath": false,
+        "nameInOutputPath": false,
+        "versionInOutputPath": false
     }
 }

package/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2017 1Computer1
+Copyright (c) 2019 André "Kody" Fernandes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,18 +1,13 @@
 # twitch-emoticons
 
-Get a Twitch channel's Twitch emotes, BTTV emotes, and FFZ emotes!
+Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!
 
-### About this fork's 2.3.0+
+### Migrating from upstream
 You must now use a Twitch user ID instead of the username to fetch user's emotes.  
 You can use [this page to quickly grab it](https://s.kdy.ch/twitchid/).
 
-_FFZ still supports names, but usage of the ID is recommended._
-
-### About this fork's 2.4.0+
-You now need to use the official Twitch API to get emotes. For this you need to provide your client id and client secret.
-To get a client and secret create a Twitch app [here](https://dev.twitch.tv/console/apps/create), it's free.
-
-If you are only using BetterTTV and FrankerFaceZ you don't need to provide anything as they are independent from the Twitch API.
+To fetch Twitch emotes you need to get a client and secret from Twitch [here](https://dev.twitch.tv/console/apps/create), it's free.  
+If you are only using BetterTTV, FrankerFaceZ and 7TV you don't need to provide Twitch app keys as they are independent from the Twitch API.
 
 ### Install
 ```sh
@@ -21,11 +16,18 @@ npm install @mkody/twitch-emoticons
 yarn add @mkody/twitch-emoticons
 ```
 
-### Example
+### Examples
+
+#### Basic Twitch emote parsing
 
 ```js
+// With ESM import
+import TwitchEmoticons from '@mkody/twitch-emoticons';
+const { EmoteFetcher, EmoteParser } = TwitchEmoticons;
+// ... or require()
 const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
 
+// Your Twitch app keys
 const clientId = '<your client id>';
 const clientSecret = '<your client secret>';
 
@@ -38,13 +40,82 @@ const parser = new EmoteParser(fetcher, {
 fetcher.fetchTwitchEmotes(null).then(() => {
     const kappa = fetcher.emotes.get('Kappa').toLink();
     console.log(kappa);
-    // https://static-cdn.jtvnw.net/emoticons/v1/25/1.0
+    // https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/1.0
 
     const text = 'Hello :CoolCat:!';
     const parsed = parser.parse(text);
     console.log(parsed);
-    // Hello ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v1/58127/1.0 "CoolCat")!
+    // Hello ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v2/58127/default/dark/1.0 "CoolCat")!
+});
+```
+
+#### All providers, global + channel, custom template and match pattern
+
+```js
+const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
+
+// Your channel ID
+const channelId = 44317909;
+
+// Your Twitch app keys
+const clientId = '<your client id>';
+const clientSecret = '<your client secret>';
+
+const fetcher = new EmoteFetcher(clientId, clientSecret);
+const parser = new EmoteParser(fetcher, {
+    template: '<img class="emote" alt="{name}" src="{link}">', // Custom HTML format
+    match: /(\w+)+?/g // Match without :colons:
 });
+
+Promise.all([
+    // Twitch global
+    fetcher.fetchTwitchEmotes(),
+    // Twitch channel
+    fetcher.fetchTwitchEmotes(channelId),
+    // BTTV global
+    fetcher.fetchBTTVEmotes(),
+    // BTTV channel
+    fetcher.fetchBTTVEmotes(channelId),
+    // 7TV global
+    fetcher.fetchSevenTVEmotes(),
+    // 7TV channel
+    fetcher.fetchSevenTVEmotes(channelId),
+    // FFZ channel
+    fetcher.fetchFFZEmotes(channelId)
+]).then(() => {
+    const globalEmotes = parser.parse('EZ Clap way too easy LUL now for the last bost monkaS');
+    console.log(globalEmotes);
+    // <img class="emote" alt="EZ" src="https://cdn.7tv.app/emote/6320bf2ad461b9ebf9413812/1x.webp"> <img class="emote" alt="Clap" src="https://cdn.7tv.app/emote/636b877aada75990352334c7/1x.webp"> way too easy <img class="emote" alt="LUL" src="https://static-cdn.jtvnw.net/emoticons/v2/425618/default/dark/1.0"> now for the last bost <img class="emote" alt="monkaS" src="https://cdn.betterttv.net/emote/56e9f494fff3cc5c35e5287e/1x">
+
+    const channelEmotes = parser.parse('KEKW that was 3Head TeriPoint');
+    console.log(channelEmotes);
+    // <img class="emote" alt="KEKW" src="https://cdn.betterttv.net/emote/5e9c6c187e090362f8b0b9e8/1x"> that was <img class="emote" alt="3Head" src="https://cdn.frankerfacez.com/emote/274406/1"> <img class="emote" alt="TeriPoint" src="https://cdn.7tv.app/emote/61dc299b600369a98b38ebef/1x.webp">
+}).catch(err => {
+    console.error('Error loading emotes...');
+    console.error(err);
+});
+```
+
+#### 7TV formats
+
+7TV v3 delivers emotes in either WEBP or AVIF.  
+By default we'll return WEBP emotes but you can override this.
+
+```js
+const { EmoteFetcher } = require('@mkody/twitch-emoticons');
+const fetcher = new EmoteFetcher();
+
+// Fetch global emotes in AVIF (channel id has to be `null` for global)
+fetcher.fetchSevenTVEmotes(null, 'avif');
+
+// Fetch 0kody's emotes with the package's default format (WEBP)
+fetcher.fetchSevenTVEmotes(44317909);
+
+// ... which is currently the same as
+fetcher.fetchSevenTVEmotes(44317909, 'webp');
+
+// Fetch Anatole's emotes in AVIF
+fetcher.fetchSevenTVEmotes(24377667, 'avif');
 ```
 
 ### Links
@@ -55,4 +126,5 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 
 This library uses the following:
 - [BetterTTV API](https://betterttv.com/)
-- [FrankerFaceZ API](http://www.frankerfacez.com/developers)
+- [FrankerFaceZ API](https://www.frankerfacez.com/developers)
+- [7TV API](https://7tv.app/)

package/docs/BTTVEmote.html

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 
 <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></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toString">toString</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#toString">toString</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#toString">toString</a></li></ul></li></ul>
+    
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="BTTVEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="Channel.html">Channel</a><ul class='methods'><li data-type='method'><a href="Channel.html#.fetchBTTVEmotes#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="Channel.html#.fetchFFZEmotes#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="Channel.html#.fetchSevenTVEmotes#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#.filter#filter">filter</a></li><li data-type='method'><a href="Collection.html#.find#find">find</a></li><li data-type='method'><a href="Collection.html#.map#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#.toString#toString">toString</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#._cacheBTTVEmote#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheFFZEmote#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheSevenTVEmote#_cacheSevenTVEmote">_cacheSevenTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._cacheTwitchEmote#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawBTTVEmotes#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawFFZEmotes#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawSevenTVEmotes#_getRawSevenTVEmotes">_getRawSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#._getRawTwitchEmotes#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchBTTVEmotes#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchFFZEmotes#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchSevenTVEmotes#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#.fetchTwitchEmotes#fetchTwitchEmotes">fetchTwitchEmotes</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#.parse#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="SevenTVEmote.html">SevenTVEmote</a><ul class='methods'><li data-type='method'><a href="SevenTVEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="SevenTVEmote.html#.toString#toString">toString</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#.toLink#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#.toString#toString">toString</a></li></ul></li></ul>
+    
 </nav>
 
 <div id="main">
@@ -45,7 +48,9 @@
 <header>
     
         <h2>
-        BTTVEmote
+        
+            BTTVEmote
+        
         </h2>
         
     
@@ -67,6 +72,10 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>A BTTV emote.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -110,12 +119,6 @@
 
 
 
-<div class="description usertext">
-    <p>A BTTV emote.</p>
-</div>
-
-
-
 
 
 
@@ -124,7 +127,7 @@
 
 
 
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
     
 
 <table class="params">
@@ -158,6 +161,7 @@
 <span class="param-type"><a href="Channel.html">Channel</a></span>
 
 
+
             
             </td>
 
@@ -181,6 +185,7 @@
 <span class="param-type">string</span>
 
 
+
             
             </td>
 
@@ -204,6 +209,7 @@
 <span class="param-type">data</span>
 
 
+
             
             </td>
 
@@ -275,6 +281,12 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The channel this emote belongs to.<br>
+Only accurate and constant on Twitch emotes.<br>
+For other types of emotes, use the <code>owner</code> or <code>ownerName</code> property.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -331,13 +343,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type"><a href="Channel.html">Channel</a></span>
 
 
+
         </li>
     </ul>
 
@@ -355,6 +368,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The code or name of the emote.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -409,13 +426,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type">string</span>
 
 
+
         </li>
     </ul>
 
@@ -433,6 +451,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The emote fetcher.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -487,13 +509,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
 
 
+
         </li>
     </ul>
 
@@ -511,6 +534,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The ID of this emote.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -565,13 +592,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type">string</span>
 
 
+
         </li>
     </ul>
 
@@ -589,6 +617,10 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The image type of the emote.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -638,13 +670,14 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type">string</span>
 
 
+
         </li>
     </ul>
 
@@ -655,13 +688,18 @@ For other types of emotes, use the <code>owner</code> or <code>ownerName</code>
 
         
             
-<h4 class="name" id="owner"><span class="type-signature">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
+<h4 class="name" id="owner"><span class="type-signature type-signature-readonly, nullable">(readonly, nullable) </span>owner<span class="type-signature"> :<a href="Channel.html">Channel</a></span></h4>
 
 
 
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The channel of this emote's creator.<br>
+Not guaranteed to contain the emote, or be cached.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -712,13 +750,14 @@ Not guaranteed to contain the emote, or be cached.</p>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type"><a href="Channel.html">Channel</a></span>
 
 
+
         </li>
     </ul>
 
@@ -729,13 +768,18 @@ Not guaranteed to contain the emote, or be cached.</p>
 
         
             
-<h4 class="name" id="ownerName"><span class="type-signature">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
+<h4 class="name" id="ownerName"><span class="type-signature type-signature-nullable">(nullable) </span>ownerName<span class="type-signature"> :string</span></h4>
 
 
 
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The name of the emote creator's channel.<br>
+Will be null for global or channel emotes.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -786,13 +830,14 @@ Will be null for global or channel emotes.</p>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type">string</span>
 
 
+
         </li>
     </ul>
 
@@ -810,6 +855,11 @@ Will be null for global or channel emotes.</p>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The type of this emote.<br>
+Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -860,18 +910,19 @@ Will be null for global or channel emotes.</p>
 
 <div class="description usertext">
     <p>The type of this emote.<br>
-Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
+Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
 </div>
 
 
 
-    <h5>Type:</h5>
+    <h5 class="h5-types">Type:</h5>
     <ul>
         <li>
             
 <span class="param-type">string</span>
 
 
+
         </li>
     </ul>
 
@@ -899,6 +950,10 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Gets the image link of the emote.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -942,12 +997,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 
-<div class="description usertext">
-    <p>Gets the image link of the emote.</p>
-</div>
-
-
-
 
 
 
@@ -956,7 +1005,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
     
 
 <table class="params">
@@ -992,6 +1041,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 <span class="param-type">number</span>
 
 
+
             
             </td>
 
@@ -1027,7 +1077,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 
@@ -1041,6 +1091,7 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 <span class="param-type">string</span>
 
 
+
     </dd>
 </dl>
 
@@ -1061,6 +1112,11 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toString</code>.<br>
+Will give the emote's name.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -1109,11 +1165,6 @@ Either <code>twitch</code>, <code>bttv</code>, or <code>ffz</code>.</p>
 
 
 
-<div class="description usertext">
-    <p>Override for <code>toString</code>.<br>
-Will give the emote's name.</p>
-</div>
-
 
 
 
@@ -1136,9 +1187,7 @@ Will give the emote's name.</p>
 
 
 
-
-
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 
@@ -1152,6 +1201,7 @@ Will give the emote's name.</p>
 <span class="param-type">string</span>
 
 
+
     </dd>
 </dl>
 
@@ -1179,7 +1229,7 @@ Will give the emote's name.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>