crazymoji v1.0.3
Why Use?
Why Keep Referencing Cheatsheets To Find Your Emojis? Simply Use This Module To Export 'Em All :sunglasses:
What Can It Do?
- Export As JSON
- Export For MARKDOWN
- Fuzzy Search For Emojis
- Create Cheatsheet
Install
Run npm install crazymoji
then add const crazymoji = require('crazymoji)
to your working file :wink:
Includes
- Smileys & Emotion
- People & Body
- Animals & Nature
- Food & Drink
- Travel & Places
- Activities
- Objects
- Symbols
- Flags
- GitHub Custom Emoji
Usage
console.log(crazymoji.find('face'));
console.log(crazymoji.find('fAce '));
console.log(crazymoji.find_exact('face_with'));
=> ':face_with_thermometer:', ':face_with_head_bandage:'
const emojis = crazymoji.get_raw();
crazymoji.emojify(emojis["Smileys & Emotion"]["Monkey Face"])
=> ':see_no_evil:', ':hear_no_evil:', ':speak_no_evil:'
API
Modules
flatten ⇒ Array.<string>
Flatter/Merge a nested array of strings
Returns: Array.<string> - - Merged/Flatter array
Param | Type | Description |
---|---|---|
nested_array | Array.<string> | Nested array of category/sub_category |
get_raw ⇒ Object
Get the RAW object containing all the emojis
Returns: Object - - The RAW data of all the emojis
categories ⇒ Array
Get the list of categories of emojis
Returns: Array - string - List of emoji categories
sub_categories ⇒ Array.<string>
Get sub-categories of emojis
Returns: Array.<string> - - List of sub categories with their parent categories
filter_by_category ⇒ object
Filter emojis by categories
Returns: object - string - List of emojis filtered by the given category
Param | Type | Description |
---|---|---|
category | string | Exact emoji category name |
emojify ⇒ array
Emojify an array
Returns: array - string
Param | Type | Description |
---|---|---|
sub_category | Array | The sub category |
find ⇒ Array.<string>
Matches emojis using fUZZY logic
Returns: Array.<string> - - Array of matched emojis
Param | Type | Description |
---|---|---|
emoji_pattern | string | name (case insensitive) of the pattern |
find_exact ⇒ Array.<string>
Matches emojis using fUZZY logic
Returns: Array.<string> - - Array of matched emojis
Param | Type | Description |
---|---|---|
emoji_pattern | string | name (case insensitive) of the pattern |
get_all_emojis ⇒ Array.<string>
List down all the emojis
Returns: Array.<string> - - List of all the emojis
Looking For A Cheatsheet ?
License
GNU Public License 3.0 Dipankar Pal 2020