https://github.com/deep5050/crazymoji

Node Module That Exports All The GitHub Emojis :wink:
https://github.com/deep5050/crazymoji

cheatsheet emoji emoji-categories emoji-picker emoji-search emoji-searcher emojis-array emojis-filter git-emoji github-emoji matches-emojis

Last synced: 26 days ago
JSON representation

Node Module That Exports All The GitHub Emojis :wink:

• Host: GitHub
• URL: https://github.com/deep5050/crazymoji
• Owner: deep5050
• License: gpl-3.0
• Created: 2020-06-06T04:12:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-08T03:50:31.000Z (over 4 years ago)
• Last Synced: 2024-04-24T18:40:48.624Z (7 months ago)
• Topics: cheatsheet, emoji, emoji-categories, emoji-picker, emoji-search, emoji-searcher, emojis-array, emojis-filter, git-emoji, github-emoji, matches-emojis
• Language: JavaScript
• Size: 113 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        






CRAZYMOJI

 Exports All The Git Emojis As JSON 







## Why Use?

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

## What Can It Do?

- [x] Export As JSON

- [x] Export For MARKDOWN

- [x] Fuzzy Search For Emojis

- [ ] Create Cheatsheet

## Install

Run `npm install crazymoji` then add `const crazymoji = require('crazymoji)` to your working file :wink:

## Includes

- [x]  Smileys & Emotion

- [x]  People & Body

- [x]  Animals & Nature

- [x]  Food & Drink

- [x]  Travel & Places

- [x]  Activities

- [x]  Objects

- [x]  Symbols

- [x]  Flags

- [x]  GitHub Custom Emoji

## Usage

```js

 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:',

...........

]

```js 

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:',

...........

]

```js

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

```

=> [ ':face_with_thermometer:', ':face_with_head_bandage:' ]

```js 

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](./cheatsheet.md)

## License

> GNU Public License 3.0 Dipankar Pal 2020

[see the license](./LICENSE)

## Other Works

[qikQR](https://girhub.com/deep5050/qikQR) . [autobadge](https://girhub.com/deep5050/autobadge) . [nonsense-license](https://girhub.com/deep5050/nonsense) . [qikstart](https://girhub.com/deep5050/qikstart)