retext-emoji

retext-emoji

retext encoding of gemoji short-codes to unicode, and decoding from unicode to short-code.

Installation

npm:

$ npm install retext-emoji

Component:

$ component install wooorm/retext-emoji

Bower:

$ bower install retext-emoji

Usage & API

emoji(options)

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

retext = new Retext().use(emoji({
    'convert' : 'encode'
}));

retext.parse('It’s raining :cat:s and :dog:s!', function (err, tree) {
    tree.toString(); // 'It’s raining 🐱s and 🐶s!'
});

• options (Object)
• options.convert ("encode" or "decode"):
  • When encode, converts short-codes into their unicode equivalent (e.g., :pig: to 🐷);
  • When decode, converts unicode emoji into their short-code equivalent (e.g., 🐷 to :pig:);

Supported Gemoji

retext-emoji supports every wooorm/gemoji. There’s a whole list of supported gemoji at gemoji's repo.

License

MIT © Titus Wormer