npm - @mkody/twitch-emoticons - Versions diffs - 2.9.6 → 3.0.0-beta.2 - Mend

@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

package/README.md +530 -169
package/dist/TwitchEmoticons.cjs +950 -0
package/dist/TwitchEmoticons.esm.min.js +7 -0
package/dist/TwitchEmoticons.esm.min.js.map +7 -0
package/dist/TwitchEmoticons.min.js +2 -20
package/dist/TwitchEmoticons.min.js.map +4 -4
package/package.json +99 -72
package/src/index.js +38 -12
package/src/struct/BTTVEmote.js +72 -74
package/src/struct/Channel.js +48 -48
package/src/struct/Emote.js +71 -71
package/src/struct/EmoteFetcher.js +358 -322
package/src/struct/EmoteParser.js +95 -84
package/src/struct/EmoteTypeMapper.js +9 -9
package/src/struct/FFZEmote.js +91 -93
package/src/struct/SevenTVEmote.js +88 -90
package/src/struct/TwitchEmote.js +72 -71
package/src/util/Collection.js +69 -55
package/src/util/Constants.js +30 -30
package/typings/index.d.cts +254 -0
package/typings/index.d.ts +216 -99
package/.jsdoc.json +0 -46
package/.nvmrc +0 -1
package/docs/BTTVEmote.html +0 -1532
package/docs/Channel.html +0 -824
package/docs/Collection.html +0 -798
package/docs/Emote.html +0 -832
package/docs/EmoteFetcher.html +0 -3741
package/docs/EmoteParser.html +0 -1187
package/docs/FFZEmote.html +0 -1686
package/docs/SevenTVEmote.html +0 -1596
package/docs/TwitchEmote.html +0 -1528
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/index.html +0 -233
package/docs/scripts/collapse.js +0 -39
package/docs/scripts/commonNav.js +0 -28
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/nav.js +0 -12
package/docs/scripts/polyfill.js +0 -4
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/scripts/search.js +0 -99
package/docs/struct_BTTVEmote.js.html +0 -162
package/docs/struct_Channel.js.html +0 -132
package/docs/struct_Emote.js.html +0 -159
package/docs/struct_EmoteFetcher.js.html +0 -429
package/docs/struct_EmoteParser.js.html +0 -172
package/docs/struct_FFZEmote.js.html +0 -185
package/docs/struct_SevenTVEmote.js.html +0 -180
package/docs/struct_TwitchEmote.js.html +0 -159
package/docs/styles/jsdoc.css +0 -776
package/docs/styles/prettify.css +0 -80
package/docs/util_Collection.js.html +0 -151
package/eslint.config.mjs +0 -215
package/jest.config.js +0 -198
package/test/BTTV.test.js +0 -48
package/test/FFZ.test.js +0 -71
package/test/SevenTV.test.js +0 -71
package/test/ToFromObject.test.js +0 -156
package/test/Twitch.test.js +0 -64
package/test/__snapshots__/ToFromObject.test.js.snap +0 -121
package/test/other.test.js +0 -72

package/docs/BTTVEmote.html DELETED Viewed

@@ -1,1532 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>BTTVEmote - 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><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>
-</nav>
-<div id="main">
-    <h1 class="page-title">BTTVEmote</h1>
-<section>
-<header>
-        <h2>
-            BTTVEmote
-        </h2>
-</header>
-<article>
-        <div class="container-overview">
-    <h4 class="name" id="BTTVEmote"><span class="type-signature"></span>new BTTVEmote<span class="signature">(channel, id, data)</span><span class="type-signature"></span></h4>
-<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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line5">line 5</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>channel</code></td>
-            <td class="type">
-<span class="param-type"><a href="Channel.html">Channel</a></span>
-            </td>
-            <td class="description last"><p>Channel this emote belongs to.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>id</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>ID of the emote.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>data</code></td>
-            <td class="type">
-<span class="param-type">data</span>
-            </td>
-            <td class="description last"><p>The raw emote data.</p></td>
-        </tr>
-    </tbody>
-</table>
-        </div>
-        <h3 class="subsection-title">Extends</h3>
-    <ul>
-        <li><a href="Emote.html">Emote</a></li>
-    </ul>
-        <h3 class="subsection-title">Members</h3>
-<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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line23">line 23</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The channel of this emote's creator.<br>
-Not guaranteed to contain the emote, or be cached.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type"><a href="Channel.html">Channel</a></span>
-        </li>
-    </ul>
-<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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line35">line 35</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The name of the emote creator's channel.<br>
-Will be null for global or channel emotes.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">string</span>
-        </li>
-    </ul>
-<h4 class="name" id="animated"><span class="type-signature"></span>animated<span class="type-signature"> :boolean</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>If emote is animated.</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line41">line 41</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>If emote is animated.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">boolean</span>
-        </li>
-    </ul>
-<h4 class="name" id="imageType"><span class="type-signature"></span>imageType<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 image type of the emote.</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line47">line 47</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The image type of the emote.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">string</span>
-        </li>
-    </ul>
-<h4 class="name" id="fetcher"><span class="type-signature"></span>fetcher<span class="type-signature"> :<a href="EmoteFetcher.html">EmoteFetcher</a></span></h4>
-<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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line19">line 19</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#fetcher">Emote#fetcher</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The emote fetcher.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type"><a href="EmoteFetcher.html">EmoteFetcher</a></span>
-        </li>
-    </ul>
-<h4 class="name" id="channel"><span class="type-signature"></span>channel<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 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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line27">line 27</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#channel">Emote#channel</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <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>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type"><a href="Channel.html">Channel</a></span>
-        </li>
-    </ul>
-<h4 class="name" id="id"><span class="type-signature"></span>id<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 ID of this emote.</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line33">line 33</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#id">Emote#id</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The ID of this emote.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">string</span>
-        </li>
-    </ul>
-<h4 class="name" id="type"><span class="type-signature"></span>type<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 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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line40">line 40</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#type">Emote#type</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The type of this emote.<br>
-Either <code>twitch</code>, <code>bttv</code>, <code>ffz</code>, or '7tv'.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">string</span>
-        </li>
-    </ul>
-<h4 class="name" id="code"><span class="type-signature"></span>code<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 code or name of the emote.</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_Emote.js.html">struct/Emote.js</a>, <a href="struct_Emote.js.html#line50">line 50</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#code">Emote#code</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    <p>The code or name of the emote.</p>
-</div>
-    <h5 class="h5-types">Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">string</span>
-        </li>
-    </ul>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id="toLink"><span class="type-signature"></span>toLink<span class="signature">(size)</span><span class="type-signature"> &rarr; {string}</span></h4>
-<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>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line55">line 55</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>size</code></td>
-            <td class="type">
-<span class="param-type">number</span>
-            </td>
-                <td class="default">
-                    <code>0</code>
-                </td>
-            <td class="description last"><p>The size of the image, 0, 1, or 2.</p></td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">string</span>
-    </dd>
-</dl>
-    <h4 class="name" id="toObject"><span class="type-signature"></span>toObject<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Override for <code>toObject</code>.<br>
-Will result in an Object representation of a BTTVEmote</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line64">line 64</a>
-    </li></ul></dd>
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="Emote.html#toObject">Emote#toObject</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">object</span>
-    </dd>
-</dl>
-    <h4 class="name" id=".fromObject"><span class="type-signature type-signature-static">(static) </span>fromObject<span class="signature">(emoteObject<span class="signature-attributes">opt</span>, channel<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BTTVEmote.html">BTTVEmote</a>}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Converts an emote Object into a BTTVEmote</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line78">line 78</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>emoteObject</code></td>
-            <td class="type">
-<span class="param-type">object</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>Object representation of this emote</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>channel</code></td>
-            <td class="type">
-<span class="param-type"><a href="Channel.html">Channel</a></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>null</code>
-                </td>
-            <td class="description last"><p>Channel this emote belongs to.</p></td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type"><a href="BTTVEmote.html">BTTVEmote</a></span>
-    </dd>
-</dl>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    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.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/polyfill.js"></script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>