<commit_before>
# regex-emoji

 [![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/regex-emoji.svg)](https://www.npmjs.com/package/regex-emoji) [![Downloads](https://img.shields.io/npm/dt/regex-emoji.svg)](https://www.npmjs.com/package/regex-emoji) [![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)

> A regex to match the :emoji: snippets in a string.

## :cloud: Installation

```sh
$ npm i --save regex-emoji
```


## :clipboard: Example



```js
const regexEmoji = require("regex-emoji")
    , matchAll = require("match-all")
    ;

console.log(regexEmoji());
// => /:([a-z0-9_]+):/g

console.log(matchAll(":house: sweet :house_with_garden:! :100: :clock1:", regexEmoji()).toArray());
// => [ "house", "house_with_garden", "100", "clock1" ]
```

## :memo: Documentation


### `emojiRegex()`
Returns the emoji regex value.

#### Return
- **RegExp** The emoji regex.



## :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:
<commit_msg>Updated docs<commit_after>
# regex-emoji

 [![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/regex-emoji.svg)](https://www.npmjs.com/package/regex-emoji) [![Downloads](https://img.shields.io/npm/dt/regex-emoji.svg)](https://www.npmjs.com/package/regex-emoji) [![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)

> A regex to match the :emoji: snippets in a string.

## :cloud: Installation

```sh
$ npm i --save regex-emoji
```


## :clipboard: Example



```js
const regexEmoji = require("regex-emoji")
    , matchAll = require("match-all")
    ;

console.log(regexEmoji());
// => /:([a-z0-9_]+):/g

console.log(matchAll(":house: sweet :house_with_garden:! :100: :clock1:", regexEmoji()).toArray());
// => [ "house", "house_with_garden", "100", "clock1" ]
```

## :memo: Documentation


### `emojiRegex()`
Returns the emoji regex value.

#### Return
- **RegExp** The emoji regex.



## :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:

{'fraction_non_alphanumeric': 0.19379373288713111, 'fraction_numerical': 0.018253726802555523, 'mean_word_length': 5.180451127819549, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 20, 'lorem ipsum': 0, 'www.': 6, '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': '3966734', 'n_tokens_mistral': 1326, 'n_tokens_neox': 1214, 'n_words': 215}