@snazzah/emoji-sync

A utility package to sync emojis with your Discord application

Installation

1pnpm i @snazzah/emoji-sync

Usage

1import { EmojiManager } from '@snazzah/emoji-sync';
2
3const manager = new EmojiManager({ token: '...' });
4
5// Note: you can add an emoji key type in the emoji manager so methods are typed properly
6// new EmojiManager<'success' | 'failure' | 'snazzah'>({ token: '...' })
7
8// Load emojis from a folder to sync with later
9await manager.loadFromFolder('./emojis', { recursive: true });
10
11// ...or manually specify emojis as an object of keys
12manager.load({
13  // file path (detects type from extension)
14  success: './emojis/success.png',
15  // data image uri
16  failure: 'data:image/png;base64,...',
17  // http(s) urls (detect from Content-Type or extension)
18  snazzah: 'https://cdn.snaz.in/avy/current.min.png'
19});
20
21// ...and sync it!
22await manager.sync();
23
24// Now that emojis are populated in the manager, you can start using them:
25
26// Get a partial emoji for use in buttons and selects
27manager.getPartial('success'); // { id: '123...', name: 'success', animated: false }
28// Get the entire emoji object
29manager.get('success'); // { id: '123...', ... }
30// Get the formatted markdown of an emoji
31manager.getMarkdown('success'); // "<:success:123>"

Updating an emoji

If you want to update an emoji, you should:

• Rename the old emoji to something else: _old_success
• Upload the new emoji under the same name
• Reload old instances of your application so that all managers use the new ID
• Remove the old emoji once other manager are up to date