crazymoji

1.0.3 • Public • Published

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

=> [ '🤒', '🤕', '👊', ':facepalm:', ':hot_face:', '🤦‍♂', '🦊', ':zany_face:', ':cold_face:', '🤓', '🌬', ':trollface:', ........... ]

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

=> [ '🤒', '🤕', '👊', ':facepalm:', ':hot_face:', '🤦‍♂', '🦊', ':zany_face:', ':cold_face:', '🤓', '🌬', ':trollface:', ........... ]

 console.log(crazymoji.find_exact('face_with'));

=> [ '🤒', '🤕' ]

const emojis = crazymoji.get_raw();
crazymoji.emojify(emojis["Smileys & Emotion"]["Monkey Face"])

=> [ '🙈', '🙉', '🙊' ]

API

Modules

flattenArray.<string>

Flatter/Merge a nested arrays of emojis

get_rawObject

Get the RAW object containing all the emojis

categoriesArray

Get the list of categories of emojis

sub_categoriesArray.<string>

Get sub-categories of emojis

filter_by_categoryobject

Filter emojis by categories

emojifyarray

Emojify an array

findArray.<string>

Matches emojis using fUZZY logic

find_exactArray.<string>

Matches emojis using fUZZY logic

get_all_emojisArray.<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

Package Sidebar

Install

npm i crazymoji

Weekly Downloads

9

Version

1.0.3

License

GPL-3.0

Unpacked Size

194 kB

Total Files

10

Last publish

Collaborators

  • deep5050