emoticon
TypeScript icon, indicating that this package has built-in type declarations

4.1.0 • Public • Published

emoticon

Build Coverage Downloads Size

List of emoticons.

Contents

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. In Node.js (version 14.14+), install with npm:

npm install emoticon

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {emoticon} from 'emoticon'

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

Yields:

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

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:

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

List of emoticons

See support.md.

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+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

Package Sidebar

Install

npm i emoticon

Weekly Downloads

404,322

Version

4.1.0

License

MIT

Unpacked Size

17.3 kB

Total Files

6

Last publish

Collaborators

  • wooorm