Awesome
emoticon
List of emoticons.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- List of emoticons
- Types
- Compatibility
- Security
- Related
- Contribute
- 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. 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 (fromwooorm/gemoji
)emoji
(string
) ā corresponding emojiemoticons
(Array<string>
) ā ASCII emoticonsname
(string
) ā name of an emoticon (preferred name fromwooorm/gemoji
)tags
(Array<string>
) ā associated tags (fromwooorm/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
wooorm/gemoji
ā info on gemoji (GitHub emoji)words/emoji-emotion
ā list of emoji rated for valencewooorm/emoticon
ā info on ASCII emoticonswooorm/strip-skin-tone
ā strip skin-tones from emojiwooorm.com/checkmoji
ā check emoji across platforms
Contribute
Yes please! See How to Contribute to Open Source.
License
MIT Ā© Titus Wormer
<!-- Definitions -->