<commit_before>
# emoji-name-map

 [![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][paypal-donations] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/emoji-name-map.svg)](https://www.npmjs.com/package/emoji-name-map) [![Downloads](https://img.shields.io/npm/dt/emoji-name-map.svg)](https://www.npmjs.com/package/emoji-name-map) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

> Name to unicode emoji mapping.

## :cloud: Installation

```sh
$ npm i --save emoji-name-map
```


## :clipboard: Example



```js
const name = require("emoji-name-map");

console.log(name.get("heart_eyes"));
// 😍

console.log(name.get(":heart_eyes:"));
// 😍

console.log(name.emoji);
// {
//   '100': '💯',
//   '1234': '🔢',
//   grinning: '😀',
//   grimacing: '😬',
//   grin: '😁',
//   joy: '😂',
//   smiley: '😃',
//   smile: '😄',
//   sweat_smile: '😅',
//   laughing: '😆',
//   innocent: '😇',
//   ...
// }
```

## :memo: Documentation


### `get(name)`
Gets the emoji character (unicode) by providing the name.

#### Params
- **String** `name`: The emoji name.

#### Return
- **String** The emoji character (unicode).



## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## :moneybag: Donations

Another way to support the development of my open-source modules is
to [set up a recurring donation, via Patreon][patreon]. :rocket:

[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.

Thanks! :heart:

## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:


 - [`emoji-dictionary`](https://github.com/IonicaBizau/emoji-dictionary#readme)—Convert emoji names in unicode characters and vice versa.
 - [`emoji-names`](https://github.com/IonicaBizau/emoji-names#readme)—Get the emoji names as array.
 - [`emoji-unicode-map`](https://github.com/IonicaBizau/emoji-unicode-map#readme)—Unicode to name emoji mapping.

## :scroll: License

[MIT][license] © [<NAME>][website]

[patreon]: https://www.patreon.com/ionicabizau
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: http://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
<commit_msg>Updated docs<commit_after>
# emoji-name-map

 [![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/emoji-name-map.svg)](https://www.npmjs.com/package/emoji-name-map) [![Downloads](https://img.shields.io/npm/dt/emoji-name-map.svg)](https://www.npmjs.com/package/emoji-name-map) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

> Name to unicode emoji mapping.

## :cloud: Installation

```sh
$ npm i --save emoji-name-map
```


## :clipboard: Example



```js
const name = require("emoji-name-map");

console.log(name.get("heart_eyes"));
// 😍

console.log(name.get(":heart_eyes:"));
// 😍

console.log(name.emoji);
// {
//   '100': '💯',
//   '1234': '🔢',
//   grinning: '😀',
//   grimacing: '😬',
//   grin: '😁',
//   joy: '😂',
//   smiley: '😃',
//   smile: '😄',
//   sweat_smile: '😅',
//   laughing: '😆',
//   innocent: '😇',
//   ...
// }
```

## :memo: Documentation


### `get(name)`
Gets the emoji character (unicode) by providing the name.

#### Params
- **String** `name`: The emoji name.

#### Return
- **String** The emoji character (unicode).



## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :moneybag: Donations

Another way to support the development of my open-source modules is
to [set up a recurring donation, via Patreon][patreon]. :rocket:

[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.

Thanks! :heart:


## :scroll: License

[MIT][license] © [<NAME>][website]

[patreon]: https://www.patreon.com/ionicabizau
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: http://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

{'fraction_non_alphanumeric': 0.20649198279233477, 'fraction_numerical': 0.01994524833789597, 'mean_word_length': 4.633259911894273, 'pattern_counts': {'":': 2, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 27, 'lorem ipsum': 0, 'www.': 10, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '841907', 'n_tokens_mistral': 2182, 'n_tokens_neox': 2048, 'n_words': 334}