Discord Emoji Converter

Module to convert Discord emoji shortcodes (ex: ":grinning:" to "😀") to emoji characters, and vice versa.

This may work for other platforms, however they are built according to Discord's emoji shortcodes, which are not standard. This does not work for custom server emojis.

Documentation

Functions

converter.getEmoji(shortcode)

This function converts a given shortcode to an emoji character and returns it. It takes one argument: shortcode, which is the emoji shortcode of the emoji to get. If the given shortcode does not exist, that is, it does not match to an emoji character, it will throw an EmojiError.

converter.getShortcode(emoji[, addColons=true])

This function converts a given emoji character and returns the shortcode of the given emoji. It takes an argument: emoji, which is a string of the emoji character to get the shortcode. It also takes an optional argument addColons, which, if false, will not add colons to either side of the shortcode. By default, it is set to true. If the given value for emoji is not mapped to a short code, it will throw an EmojiError.

converter.emojify(str)

This function replaces all shortcodes (that are wrapped in colons) with emoji characters. It takes one argument: str, which is the string to "emojify" or replace shortcodes in. Any shortcodes that do not exist are simply skipped. This function does not trim or change the capitalization of the string. It does not throw any custom errors.

Constants

converter.emojis

This constant is the main data object with shortcodes (not including colons) as keys, and emoji characters as values. Found in emojis.json.

Errors

converter.EmojiError

This error is a generic error message class, taking a single argument: message, which is a string representing the message of the new error. The default value is ''. Basically, it's Error but called EmojiError.

Credits

Originally data was retrieved from kangalioo, however, now (as of v1.2.0) data is retrieved from the discord-emoji package on NPM.

License

Licensed under the MIT License. View license here.