@mkody/twitch-emoticons 2.6.0 → 2.6.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.
- package/.github/codeql/codeql-config.yml +5 -0
- package/.github/workflows/codeql.yml +50 -0
- package/.github/workflows/eslint.yml +51 -0
- package/.github/workflows/yarn-test.yml +0 -1
- package/docs/BTTVEmote.html +2 -2
- package/docs/Channel.html +2 -2
- package/docs/Collection.html +2 -2
- package/docs/Emote.html +2 -2
- package/docs/EmoteFetcher.html +2694 -2694
- package/docs/EmoteParser.html +2 -2
- package/docs/FFZEmote.html +2 -2
- package/docs/SevenTVEmote.html +1317 -1317
- package/docs/TwitchEmote.html +2 -2
- package/docs/index.html +201 -201
- package/docs/struct_BTTVEmote.js.html +2 -2
- package/docs/struct_Channel.js.html +2 -2
- package/docs/struct_Emote.js.html +2 -2
- package/docs/struct_EmoteFetcher.js.html +75 -75
- package/docs/struct_EmoteParser.js.html +2 -2
- package/docs/struct_FFZEmote.js.html +2 -2
- package/docs/struct_SevenTVEmote.js.html +72 -72
- package/docs/struct_TwitchEmote.js.html +2 -2
- package/docs/util_Collection.js.html +2 -2
- package/package.json +10 -7
- package/src/struct/EmoteFetcher.js +3 -3
- package/test/index.js +2 -2
package/docs/TwitchEmote.html
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<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
|
|
32
|
+
<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#_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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -1225,7 +1225,7 @@ Will give the emote's name.</p></li></ul></dd>
|
|
|
1225
1225
|
<br class="clear">
|
|
1226
1226
|
|
|
1227
1227
|
<footer>
|
|
1228
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
1228
|
+
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.
|
|
1229
1229
|
</footer>
|
|
1230
1230
|
|
|
1231
1231
|
<script>prettyPrint();</script>
|
package/docs/index.html
CHANGED
|
@@ -1,202 +1,202 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
|
|
5
|
-
<meta charset="utf-8">
|
|
6
|
-
<title>Home - Documentation</title>
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
<script src="scripts/prettify/prettify.js"></script>
|
|
10
|
-
<script src="scripts/prettify/lang-css.js"></script>
|
|
11
|
-
<!--[if lt IE 9]>
|
|
12
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
13
|
-
<![endif]-->
|
|
14
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
15
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
16
|
-
<script src="scripts/nav.js" defer></script>
|
|
17
|
-
|
|
18
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
19
|
-
</head>
|
|
20
|
-
<body>
|
|
21
|
-
|
|
22
|
-
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
23
|
-
<label for="nav-trigger" class="navicon-button x">
|
|
24
|
-
<div class="navicon"></div>
|
|
25
|
-
</label>
|
|
26
|
-
|
|
27
|
-
<label for="nav-trigger" class="overlay"></label>
|
|
28
|
-
|
|
29
|
-
<nav >
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html
|
|
33
|
-
|
|
34
|
-
</nav>
|
|
35
|
-
|
|
36
|
-
<div id="main">
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
<section class="package">
|
|
47
|
-
<h3>@mkody/twitch-emoticons 2.
|
|
48
|
-
</section>
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
<section class="readme usertext">
|
|
63
|
-
<article><h1>twitch-emoticons</h1>
|
|
64
|
-
<p>Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!</p>
|
|
65
|
-
<h3>Migrating from upstream</h3>
|
|
66
|
-
<p>You must now use a Twitch user ID instead of the username to fetch user's emotes.<br>
|
|
67
|
-
You can use <a href="https://s.kdy.ch/twitchid/">this page to quickly grab it</a>.</p>
|
|
68
|
-
<p>To fetch Twitch emotes you need to get a client and secret from Twitch <a href="https://dev.twitch.tv/console/apps/create">here</a>, it's free.<br>
|
|
69
|
-
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.</p>
|
|
70
|
-
<h3>Install</h3>
|
|
71
|
-
<pre class="prettyprint source lang-sh"><code>npm install @mkody/twitch-emoticons
|
|
72
|
-
# or
|
|
73
|
-
yarn add @mkody/twitch-emoticons
|
|
74
|
-
</code></pre>
|
|
75
|
-
<h3>Examples</h3>
|
|
76
|
-
<h4>Basic Twitch emote parsing</h4>
|
|
77
|
-
<pre class="prettyprint source lang-js"><code>// With ESM import
|
|
78
|
-
import TwitchEmoticons from '@mkody/twitch-emoticons';
|
|
79
|
-
const { EmoteFetcher, EmoteParser } = TwitchEmoticons;
|
|
80
|
-
// ... or require()
|
|
81
|
-
const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
|
|
82
|
-
|
|
83
|
-
// Your Twitch app keys
|
|
84
|
-
const clientId = '<your client id>';
|
|
85
|
-
const clientSecret = '<your client secret>';
|
|
86
|
-
|
|
87
|
-
const fetcher = new EmoteFetcher(clientId, clientSecret);
|
|
88
|
-
const parser = new EmoteParser(fetcher, {
|
|
89
|
-
type: 'markdown',
|
|
90
|
-
match: /:(.+?):/g
|
|
91
|
-
});
|
|
92
|
-
|
|
93
|
-
fetcher.fetchTwitchEmotes(null).then(() => {
|
|
94
|
-
const kappa = fetcher.emotes.get('Kappa').toLink();
|
|
95
|
-
console.log(kappa);
|
|
96
|
-
// https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/1.0
|
|
97
|
-
|
|
98
|
-
const text = 'Hello :CoolCat:!';
|
|
99
|
-
const parsed = parser.parse(text);
|
|
100
|
-
console.log(parsed);
|
|
101
|
-
// Hello !
|
|
102
|
-
});
|
|
103
|
-
</code></pre>
|
|
104
|
-
<h4>All providers, global + channel, custom template and match pattern</h4>
|
|
105
|
-
<pre class="prettyprint source lang-js"><code>const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
|
|
106
|
-
|
|
107
|
-
// Your channel ID
|
|
108
|
-
const channelId = 44317909;
|
|
109
|
-
|
|
110
|
-
// Your Twitch app keys
|
|
111
|
-
const clientId = '<your client id>';
|
|
112
|
-
const clientSecret = '<your client secret>';
|
|
113
|
-
|
|
114
|
-
const fetcher = new EmoteFetcher(clientId, clientSecret);
|
|
115
|
-
const parser = new EmoteParser(fetcher, {
|
|
116
|
-
template: '<img class="emote" alt="{name}" src="{link}">', // Custom HTML format
|
|
117
|
-
match: /(\w+)+?/g // Match without :colons:
|
|
118
|
-
});
|
|
119
|
-
|
|
120
|
-
Promise.all([
|
|
121
|
-
// Twitch global
|
|
122
|
-
fetcher.fetchTwitchEmotes(),
|
|
123
|
-
// Twitch channel
|
|
124
|
-
fetcher.fetchTwitchEmotes(channelId),
|
|
125
|
-
// BTTV global
|
|
126
|
-
fetcher.fetchBTTVEmotes(),
|
|
127
|
-
// BTTV channel
|
|
128
|
-
fetcher.fetchBTTVEmotes(channelId),
|
|
129
|
-
// 7TV global
|
|
130
|
-
fetcher.fetchSevenTVEmotes(),
|
|
131
|
-
// 7TV channel
|
|
132
|
-
fetcher.fetchSevenTVEmotes(channelId),
|
|
133
|
-
// FFZ channel
|
|
134
|
-
fetcher.fetchFFZEmotes(channelId)
|
|
135
|
-
]).then(() => {
|
|
136
|
-
const globalEmotes = parser.parse('EZ Clap way too easy LUL now for the last bost monkaS');
|
|
137
|
-
console.log(globalEmotes);
|
|
138
|
-
// <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">
|
|
139
|
-
|
|
140
|
-
const channelEmotes = parser.parse('KEKW that was 3Head TeriPoint');
|
|
141
|
-
console.log(channelEmotes);
|
|
142
|
-
// <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">
|
|
143
|
-
}).catch(err => {
|
|
144
|
-
console.error('Error loading emotes...');
|
|
145
|
-
console.error(err);
|
|
146
|
-
});
|
|
147
|
-
</code></pre>
|
|
148
|
-
<h4>7TV formats</h4>
|
|
149
|
-
<p>7TV v3 delivers emotes in either WEBP or AVIF.<br>
|
|
150
|
-
By default we'll return WEBP emotes but you can override this.</p>
|
|
151
|
-
<pre class="prettyprint source lang-js"><code>const { EmoteFetcher } = require('@mkody/twitch-emoticons');
|
|
152
|
-
const fetcher = new EmoteFetcher();
|
|
153
|
-
|
|
154
|
-
// Fetch global emotes in AVIF (channel id has to be `null` for global)
|
|
155
|
-
fetcher.fetchSevenTVEmotes(null, 'avif');
|
|
156
|
-
|
|
157
|
-
// Fetch 0kody's emotes with the package's default format (WEBP)
|
|
158
|
-
fetcher.fetchSevenTVEmotes(44317909);
|
|
159
|
-
|
|
160
|
-
// ... which is currently the same as
|
|
161
|
-
fetcher.fetchSevenTVEmotes(44317909, 'webp');
|
|
162
|
-
|
|
163
|
-
// Fetch Anatole's emotes in AVIF
|
|
164
|
-
fetcher.fetchSevenTVEmotes(24377667, 'avif');
|
|
165
|
-
</code></pre>
|
|
166
|
-
<h3>Links</h3>
|
|
167
|
-
<ul>
|
|
168
|
-
<li><a href="https://github.com/mkody/twitch-emoticons">Github</a></li>
|
|
169
|
-
<li><a href="https://mkody.github.io/twitch-emoticons/">Documentation</a></li>
|
|
170
|
-
<li><a href="https://github.com/mkody/twitch-emoticons/releases">Changelog</a></li>
|
|
171
|
-
</ul>
|
|
172
|
-
<p>This library uses the following:</p>
|
|
173
|
-
<ul>
|
|
174
|
-
<li><a href="https://betterttv.com/">BetterTTV API</a></li>
|
|
175
|
-
<li><a href="https://www.frankerfacez.com/developers">FrankerFaceZ API</a></li>
|
|
176
|
-
<li><a href="https://7tv.app/">7TV API</a></li>
|
|
177
|
-
</ul></article>
|
|
178
|
-
</section>
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
</div>
|
|
188
|
-
|
|
189
|
-
<br class="clear">
|
|
190
|
-
|
|
191
|
-
<footer>
|
|
192
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
193
|
-
</footer>
|
|
194
|
-
|
|
195
|
-
<script>prettyPrint();</script>
|
|
196
|
-
<script src="scripts/polyfill.js"></script>
|
|
197
|
-
<script src="scripts/linenumber.js"></script>
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
</body>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<title>Home - Documentation</title>
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
<script src="scripts/prettify/prettify.js"></script>
|
|
10
|
+
<script src="scripts/prettify/lang-css.js"></script>
|
|
11
|
+
<!--[if lt IE 9]>
|
|
12
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
13
|
+
<![endif]-->
|
|
14
|
+
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
15
|
+
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
16
|
+
<script src="scripts/nav.js" defer></script>
|
|
17
|
+
|
|
18
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
19
|
+
</head>
|
|
20
|
+
<body>
|
|
21
|
+
|
|
22
|
+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
23
|
+
<label for="nav-trigger" class="navicon-button x">
|
|
24
|
+
<div class="navicon"></div>
|
|
25
|
+
</label>
|
|
26
|
+
|
|
27
|
+
<label for="nav-trigger" class="overlay"></label>
|
|
28
|
+
|
|
29
|
+
<nav >
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<h2><a href="index.html">Home</a></h2><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#_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>
|
|
33
|
+
|
|
34
|
+
</nav>
|
|
35
|
+
|
|
36
|
+
<div id="main">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<section class="package">
|
|
47
|
+
<h3>@mkody/twitch-emoticons 2.6.2</h3>
|
|
48
|
+
</section>
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
<section class="readme usertext">
|
|
63
|
+
<article><h1>twitch-emoticons</h1>
|
|
64
|
+
<p>Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!</p>
|
|
65
|
+
<h3>Migrating from upstream</h3>
|
|
66
|
+
<p>You must now use a Twitch user ID instead of the username to fetch user's emotes.<br>
|
|
67
|
+
You can use <a href="https://s.kdy.ch/twitchid/">this page to quickly grab it</a>.</p>
|
|
68
|
+
<p>To fetch Twitch emotes you need to get a client and secret from Twitch <a href="https://dev.twitch.tv/console/apps/create">here</a>, it's free.<br>
|
|
69
|
+
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.</p>
|
|
70
|
+
<h3>Install</h3>
|
|
71
|
+
<pre class="prettyprint source lang-sh"><code>npm install @mkody/twitch-emoticons
|
|
72
|
+
# or
|
|
73
|
+
yarn add @mkody/twitch-emoticons
|
|
74
|
+
</code></pre>
|
|
75
|
+
<h3>Examples</h3>
|
|
76
|
+
<h4>Basic Twitch emote parsing</h4>
|
|
77
|
+
<pre class="prettyprint source lang-js"><code>// With ESM import
|
|
78
|
+
import TwitchEmoticons from '@mkody/twitch-emoticons';
|
|
79
|
+
const { EmoteFetcher, EmoteParser } = TwitchEmoticons;
|
|
80
|
+
// ... or require()
|
|
81
|
+
const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
|
|
82
|
+
|
|
83
|
+
// Your Twitch app keys
|
|
84
|
+
const clientId = '<your client id>';
|
|
85
|
+
const clientSecret = '<your client secret>';
|
|
86
|
+
|
|
87
|
+
const fetcher = new EmoteFetcher(clientId, clientSecret);
|
|
88
|
+
const parser = new EmoteParser(fetcher, {
|
|
89
|
+
type: 'markdown',
|
|
90
|
+
match: /:(.+?):/g
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
fetcher.fetchTwitchEmotes(null).then(() => {
|
|
94
|
+
const kappa = fetcher.emotes.get('Kappa').toLink();
|
|
95
|
+
console.log(kappa);
|
|
96
|
+
// https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/1.0
|
|
97
|
+
|
|
98
|
+
const text = 'Hello :CoolCat:!';
|
|
99
|
+
const parsed = parser.parse(text);
|
|
100
|
+
console.log(parsed);
|
|
101
|
+
// Hello !
|
|
102
|
+
});
|
|
103
|
+
</code></pre>
|
|
104
|
+
<h4>All providers, global + channel, custom template and match pattern</h4>
|
|
105
|
+
<pre class="prettyprint source lang-js"><code>const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
|
|
106
|
+
|
|
107
|
+
// Your channel ID
|
|
108
|
+
const channelId = 44317909;
|
|
109
|
+
|
|
110
|
+
// Your Twitch app keys
|
|
111
|
+
const clientId = '<your client id>';
|
|
112
|
+
const clientSecret = '<your client secret>';
|
|
113
|
+
|
|
114
|
+
const fetcher = new EmoteFetcher(clientId, clientSecret);
|
|
115
|
+
const parser = new EmoteParser(fetcher, {
|
|
116
|
+
template: '<img class="emote" alt="{name}" src="{link}">', // Custom HTML format
|
|
117
|
+
match: /(\w+)+?/g // Match without :colons:
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
Promise.all([
|
|
121
|
+
// Twitch global
|
|
122
|
+
fetcher.fetchTwitchEmotes(),
|
|
123
|
+
// Twitch channel
|
|
124
|
+
fetcher.fetchTwitchEmotes(channelId),
|
|
125
|
+
// BTTV global
|
|
126
|
+
fetcher.fetchBTTVEmotes(),
|
|
127
|
+
// BTTV channel
|
|
128
|
+
fetcher.fetchBTTVEmotes(channelId),
|
|
129
|
+
// 7TV global
|
|
130
|
+
fetcher.fetchSevenTVEmotes(),
|
|
131
|
+
// 7TV channel
|
|
132
|
+
fetcher.fetchSevenTVEmotes(channelId),
|
|
133
|
+
// FFZ channel
|
|
134
|
+
fetcher.fetchFFZEmotes(channelId)
|
|
135
|
+
]).then(() => {
|
|
136
|
+
const globalEmotes = parser.parse('EZ Clap way too easy LUL now for the last bost monkaS');
|
|
137
|
+
console.log(globalEmotes);
|
|
138
|
+
// <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">
|
|
139
|
+
|
|
140
|
+
const channelEmotes = parser.parse('KEKW that was 3Head TeriPoint');
|
|
141
|
+
console.log(channelEmotes);
|
|
142
|
+
// <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">
|
|
143
|
+
}).catch(err => {
|
|
144
|
+
console.error('Error loading emotes...');
|
|
145
|
+
console.error(err);
|
|
146
|
+
});
|
|
147
|
+
</code></pre>
|
|
148
|
+
<h4>7TV formats</h4>
|
|
149
|
+
<p>7TV v3 delivers emotes in either WEBP or AVIF.<br>
|
|
150
|
+
By default we'll return WEBP emotes but you can override this.</p>
|
|
151
|
+
<pre class="prettyprint source lang-js"><code>const { EmoteFetcher } = require('@mkody/twitch-emoticons');
|
|
152
|
+
const fetcher = new EmoteFetcher();
|
|
153
|
+
|
|
154
|
+
// Fetch global emotes in AVIF (channel id has to be `null` for global)
|
|
155
|
+
fetcher.fetchSevenTVEmotes(null, 'avif');
|
|
156
|
+
|
|
157
|
+
// Fetch 0kody's emotes with the package's default format (WEBP)
|
|
158
|
+
fetcher.fetchSevenTVEmotes(44317909);
|
|
159
|
+
|
|
160
|
+
// ... which is currently the same as
|
|
161
|
+
fetcher.fetchSevenTVEmotes(44317909, 'webp');
|
|
162
|
+
|
|
163
|
+
// Fetch Anatole's emotes in AVIF
|
|
164
|
+
fetcher.fetchSevenTVEmotes(24377667, 'avif');
|
|
165
|
+
</code></pre>
|
|
166
|
+
<h3>Links</h3>
|
|
167
|
+
<ul>
|
|
168
|
+
<li><a href="https://github.com/mkody/twitch-emoticons">Github</a></li>
|
|
169
|
+
<li><a href="https://mkody.github.io/twitch-emoticons/">Documentation</a></li>
|
|
170
|
+
<li><a href="https://github.com/mkody/twitch-emoticons/releases">Changelog</a></li>
|
|
171
|
+
</ul>
|
|
172
|
+
<p>This library uses the following:</p>
|
|
173
|
+
<ul>
|
|
174
|
+
<li><a href="https://betterttv.com/">BetterTTV API</a></li>
|
|
175
|
+
<li><a href="https://www.frankerfacez.com/developers">FrankerFaceZ API</a></li>
|
|
176
|
+
<li><a href="https://7tv.app/">7TV API</a></li>
|
|
177
|
+
</ul></article>
|
|
178
|
+
</section>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
<br class="clear">
|
|
190
|
+
|
|
191
|
+
<footer>
|
|
192
|
+
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.
|
|
193
|
+
</footer>
|
|
194
|
+
|
|
195
|
+
<script>prettyPrint();</script>
|
|
196
|
+
<script src="scripts/polyfill.js"></script>
|
|
197
|
+
<script src="scripts/linenumber.js"></script>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</body>
|
|
202
202
|
</html>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<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
|
|
32
|
+
<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#_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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -113,7 +113,7 @@ module.exports = BTTVEmote;
|
|
|
113
113
|
<br class="clear">
|
|
114
114
|
|
|
115
115
|
<footer>
|
|
116
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
116
|
+
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.
|
|
117
117
|
</footer>
|
|
118
118
|
|
|
119
119
|
<script>prettyPrint();</script>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<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
|
|
32
|
+
<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#_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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -114,7 +114,7 @@ module.exports = Channel;
|
|
|
114
114
|
<br class="clear">
|
|
115
115
|
|
|
116
116
|
<footer>
|
|
117
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
117
|
+
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.
|
|
118
118
|
</footer>
|
|
119
119
|
|
|
120
120
|
<script>prettyPrint();</script>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<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
|
|
32
|
+
<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#_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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -124,7 +124,7 @@ module.exports = Emote;
|
|
|
124
124
|
<br class="clear">
|
|
125
125
|
|
|
126
126
|
<footer>
|
|
127
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.
|
|
127
|
+
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.
|
|
128
128
|
</footer>
|
|
129
129
|
|
|
130
130
|
<script>prettyPrint();</script>
|