<commit_before># emoticon

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]

List of emoticons.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`emoticon`](#emoticon-1)
*   [Types](#types)
*   [List of emoticons](#list-of-emoticons)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Related](#related)
*   [Contribute](#contribute)
*   [License](#license)

## What is this?

This package contains info on ASCII emoticons.
:p

## When should I use this?

You can use this package for several reasons, typically in a build script,
for example to figure out which text emoticons map to what emoji.

## Install

This package is [ESM only][esm].
In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:

```sh
npm install emoticon
```

In Deno with [`esm.sh`][esmsh]:

```js
import {emoticon} from 'https://esm.sh/emoticon@4'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
  import {emoticon} from 'https://esm.sh/emoticon@4?bundle'
</script>
```

## Use

```js
import {emoticon} from 'emoticon'

console.log(emoticon.slice(0, 3))
```

Yields:

```js
[ { name: 'angry',
    emoji: '😠',
    tags: [ 'mad', 'annoyed' ],
    description: 'angry face',
    emoticons:
     [ '>:(', '>:[', '>:-(', '>:-[', '>=(', '>=[', '>=-(', '>=-[' ] },
  { name: 'blush',
    emoji: '😊',
    tags: [ 'proud' ],
    description: 'smiling face with smiling eyes',
    emoticons:
     [ ':")',
       ':"]',
       ':"D',
       ':-")',
       ':-"]',
       ':-"D',
       '=")',
       '="]',
       '="D',
       '=-")',
       '=-"]',
       '=-"D' ] },
  { name: 'broken_heart',
    emoji: '💔',
    tags: [],
    description: 'broken heart',
    emoticons: [ '<\\3', '</3' ] } ]
```

## API

This package exports the following identifier: `emoticon`.
There is no default export.

### `emoticon`

List of emoticons (`Array<Emoticon>`), where each entry has the following
fields:

*   `name` (`string`)
    — name of an emoticon (preferred name from [`wooorm/gemoji`][gemoji])
*   `emoji` (`string`)
    — corresponding emoji
*   `tags` (`Array<string>`)
    — associated tags (from [`wooorm/gemoji`][gemoji])
*   `description` (`string`)
    — associated description (from [`wooorm/gemoji`][gemoji])
*   `emoticons` (`Array<string>`)
    — ASCII emoticons

## Types

This package is fully typed with [TypeScript][].
It exports an additional `Emoticon` type that models its respective interface.

## List of emoticons

See [`support.md`][support].

## Compatibility

This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
It also works in Deno and modern browsers.

## Security

This package is safe.

## Related

*   [`wooorm/gemoji`][gemoji]
    — info on gemoji (GitHub emoji)<commit_msg>Refactor some docs<commit_after># emoticon

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]

List of emoticons.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`emoticon`](#emoticon-1)
*   [List of emoticons](#list-of-emoticons)
*   [Types](#types)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Related](#related)
*   [Contribute](#contribute)
*   [License](#license)

## What is this?

This package contains info on ASCII emoticons.
:p

## When should I use this?

You can use this package for several reasons, typically in a build script,
for example to figure out which text emoticons map to what emoji.

## Install

This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:

```sh
npm install emoticon
```

In Deno with [`esm.sh`][esmsh]:

```js
import {emoticon} from 'https://esm.sh/emoticon@4'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
  import {emoticon} from 'https://esm.sh/emoticon@4?bundle'
</script>
```

## Use

```js
import {emoticon} from 'emoticon'

console.log(emoticon.slice(0, 3))
```

Yields:

```js
[ { name: 'angry',
    emoji: '😠',
    tags: [ 'mad', 'annoyed' ],
    description: 'angry face',
    emoticons:
     [ '>:(', '>:[', '>:-(', '>:-[', '>=(', '>=[', '>=-(', '>=-[' ] },
  { name: 'blush',
    emoji: '😊',
    tags: [ 'proud' ],
    description: 'smiling face with smiling eyes',
    emoticons:
     [ ':")',
       ':"]',
       ':"D',
       ':-")',
       ':-"]',
       ':-"D',
       '=")',
       '="]',
       '="D',
       '=-")',
       '=-"]',
       '=-"D' ] },
  { name: 'broken_heart',
    emoji: '💔',
    tags: [],
    description: 'broken heart',
    emoticons: [ '<\\3', '</3' ] } ]
```

## API

This package exports the identifier `emoticon`.
There is no default export.

### `emoticon`

List of emoticons (`Array<Emoticon>`), where each entry has the following
fields:

*   `name` (`string`)
    — name of an emoticon (preferred name from [`wooorm/gemoji`][gemoji])
*   `emoji` (`string`)
    — corresponding emoji
*   `tags` (`Array<string>`)
    — associated tags (from [`wooorm/gemoji`][gemoji])
*   `description` (`string`)
    — associated description (from [`wooorm/gemoji`][gemoji])
*   `emoticons` (`Array<string>`)
    — ASCII emoticons

## List of emoticons

See [`support.md`][support].

## Types

This package is fully typed with [TypeScript][].
It exports an additional type `Emoticon`.

## Compatibility

This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.

## Security

This package is safe.

## Related

*   [`wooorm/gemoji`][gemoji]
    — info on gemoji (GitHub emoji)
{'fraction_non_alphanumeric': 0.20526580580244844, 'fraction_numerical': 0.008385041086701324, 'mean_word_length': 3.4909638554216866, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 29, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1107201', 'n_tokens_mistral': 2303, 'n_tokens_neox': 2213, 'n_words': 572}