@mkody/twitch-emoticons 2.7.0 → 2.8.0

package/LICENSE

@@ -1,22 +1,22 @@
-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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -49,6 +49,18 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 });
 ```
 
+#### Bring your own `@twurple/api`
+
+If you already use [Twurple](https://twurple.js.org/) in your project and manage authentification
+(i.e. with user tokens), you can reuse it in this project by skipping the first two paramters and
+setting `apiClient` with your [ApiClient](https://twurple.js.org/reference/api/classes/ApiClient.html) object.
+
+```js
+const fetcher = new EmoteFetcher(null, null, {
+    apiClient: yourOwnTwurpleApiClientHere
+});
+```
+
 #### All providers, global + channel, custom template and match pattern
 
 ```js
@@ -110,16 +122,36 @@ 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');
+await fetcher.fetchSevenTVEmotes(null, 'avif');
 
 // Fetch 0kody's emotes with the package's default format (WEBP)
-fetcher.fetchSevenTVEmotes(44317909);
+await fetcher.fetchSevenTVEmotes(44317909);
 
 // ... which is currently the same as
-fetcher.fetchSevenTVEmotes(44317909, 'webp');
+await fetcher.fetchSevenTVEmotes(44317909, 'webp');
 
 // Fetch Anatole's emotes in AVIF
-fetcher.fetchSevenTVEmotes(24377667, 'avif');
+await fetcher.fetchSevenTVEmotes(24377667, 'avif');
+```
+
+#### Export and import emote data
+
+This can be useful to save the emotes in a cache or for offline content.  
+(For offline content, you'll still need to download emotes and proxy their URLs.)
+
+```js
+const { EmoteFetcher } = require('@mkody/twitch-emoticons');
+const fetcher = new EmoteFetcher();
+
+// First fetch some emotes
+await fetcher.fetchSevenTVEmotes(null, 'avif');
+
+// Then you can use .toObject() on an `Emote` to export its data.
+// Here's a map to get them all in a single array.
+const emotes = fetcher.emotes.map(emote => emote.toObject());
+
+// Later, with or without a fresh `EmoteFetcher`, you can use .fromObject() on the fetcher.
+fetcher.fromObject(emotes);
 ```
 
 ### Links