node-emoji
simple emoji support for node.js projects
Installation
To install node-emoji
, you need node.js and npm. ๐
Once you have that set-up, just run npm install --save node-emoji
in your project directory. ๐ข
You're now ready to use emoji in your node projects! Awesome!
Usage
var emoji = require('node-emoji')
emoji.get('coffee') // returns the emoji code for coffee (displays emoji on terminals that support it)
emoji.which(emoji.get('coffee')) // returns the string "coffee"
emoji.get(':fast_forward:') // `.get` also supports github flavored markdown emoji (http://www.emoji-cheat-sheet.com/)
emoji.emojify('I :heart: :coffee:!') // replaces all :emoji: with the actual emoji, in this case: returns "I โค๏ธ โ๏ธ!"
emoji.random() // returns a random emoji + key, e.g. `{ emoji: 'โค๏ธ', key: 'heart' }`
emoji.search('cof') // returns an array of objects with matching emoji's. `[{ emoji: 'โ๏ธ', key: 'coffee' }, { emoji: โฐ', key: 'coffin'}]`
Adding new emoji
Emoji come from js-emoji (Thanks a lot
To update the list or add custom emoji, clone this repository and put them into lib/emojifile.js
.
Then run npm run-script emojiparse
in the project directory or node emojiparse
in the lib directory.
This should generate the new emoji.json file and output Done.
.
That's all, you now have more emoji you can use!
Support / Donations
If you want to support node-emoji development, please consider donating (it helps me keeping my projects active and alive!):