retext-emoji

retext-emoji

Emoji, gemoji, and emoticons in retext.

Installation

npm:

npm install retext-emoji

retext-emoji is also available as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

Dependencies:

var retext = require('retext');
var emoji = require('retext-emoji');

Process:

var file = retext()
    .use(emoji, {convert: 'encode'})
    .process('I’m going to bed. :zzz:');

Yields:

I’m going to bed. 💤

API

retext().use(emoji[, options])

Emoji, gemoji, and emoticons in retext.

options

• convert ('encode' or 'decode', optional) — When encode, converts short-codes and emoticons to their unicode equivalent (:heart: and <3 to ❤️); When decode, converts unicode emoji and emoticons to their short-code equivalent (❤️ and <3 to :heart:).

Returns

string.

EmoticonNode

retext-emoji adds a new node to NLCST: Emoticon (Symbol).

Whether emoji (❤️), emoticon (<3), or gemoji (:heart:), all are classified as EmoticonNodes.

interface Emoticon < Symbol {
    type: "EmoticonNode";
    data: EmoticonData;
}

interface EmoticonData {
    names: [string];
    description: string | null;
    tags: [string];
}

Support

retext-emoji supports every wooorm/gemoji and every wooorm/emoticon.

License

MIT © Titus Wormer