Skip to content

Node Module That Exports All The GitHub Emojis πŸ˜‰

License

Notifications You must be signed in to change notification settings

deep5050/crazymoji

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

22 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CRAZYMOJI

Exports All The Git Emojis As JSON

npm

Why Use?

Why Keep Referencing Cheatsheets To Find Your Emojis? Simply Use This Module To Export 'Em All 😎

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 πŸ˜‰

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 arrays of emojis

get_raw β‡’ Object

Get the RAW object containing all the emojis

categories β‡’ Array

Get the list of categories of emojis

sub_categories β‡’ Array.<string>

Get sub-categories of emojis

filter_by_category β‡’ object

Filter emojis by categories

emojify β‡’ array

Emojify an array

find β‡’ Array.<string>

Matches emojis using fUZZY logic

find_exact β‡’ Array.<string>

Matches emojis using fUZZY logic

get_all_emojis β‡’ Array.<string>

List down all the emojis

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 ?

crazymoji cheatsheet

License

GNU Public License 3.0 Dipankar Pal 2020

see the license

Other Works

qikQR . autobadge . nonsense-license . qikstart