1.0.3 • Published 4 years ago

crazymoji v1.0.3

Weekly downloads
2
License
GPL-3.0
Repository
github
Last release
4 years ago

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'));

=> ':face_with_thermometer:', ':face_with_head_bandage:', ':facepunch:', ':facepalm:', ':hot_face:', ':man_facepalming:', ':fox_face:', ':zany_face:', ':cold_face:', ':nerd_face:', ':wind_face:', ':trollface:', ...........

console.log(crazymoji.find('fAce        '));

=> ':face_with_thermometer:', ':face_with_head_bandage:', ':facepunch:', ':facepalm:', ':hot_face:', ':man_facepalming:', ':fox_face:', ':zany_face:', ':cold_face:', ':nerd_face:', ':wind_face:', ':trollface:', ...........

 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

ParamTypeDescription
nested_arrayArray.<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

ParamTypeDescription
categorystringExact emoji category name

emojify ⇒ array

Emojify an array

Returns: array - string

ParamTypeDescription
sub_categoryArrayThe sub category

find ⇒ Array.<string>

Matches emojis using fUZZY logic

Returns: Array.<string> - - Array of matched emojis

ParamTypeDescription
emoji_patternstringname (case insensitive) of the pattern

find_exact ⇒ Array.<string>

Matches emojis using fUZZY logic

Returns: Array.<string> - - Array of matched emojis

ParamTypeDescription
emoji_patternstringname (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 ?

crazymoji cheatsheet

License

GNU Public License 3.0 Dipankar Pal 2020

see the license

Other Works

qikQR . autobadge . nonsense-license . qikstart