Info on gemoji.
This package contains info on gemoji (GitHub Emoji).
Gemoji are the shortcodes that GitHub uses to represent emoji.
For example, :grinning:
can be used for 😀
.
Use this package if you need:
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install gemoji
In Deno with esm.sh
:
import {gemoji} from 'https://esm.sh/gemoji@8'
In browsers with esm.sh
:
<script type="module">
import {gemoji} from 'https://esm.sh/gemoji@8?bundle'
</script>
See examples below.
This package exports the identifiers gemoji
, emojiToName
, and
nameToEmoji
.
There is no default export.
gemoji
List of info objects (Array<Gemoji>
).
Each Gemoji
has the following fields:
emoji
(string
)😀
names
(Array<string>
)['grinning']
tags
(Array<string>
)['smile', 'happy']
description
(string
)grinning face
category
(string
)Smileys & Emotion
import {gemoji} from 'gemoji'
console.log(gemoji)
Yields:
[
{
emoji: '😀',
names: ['grinning'],
tags: ['smile', 'happy'],
description: 'grinning face',
category: 'Smileys & Emotion'
},
{
emoji: '😃',
names: ['smiley'],
tags: ['happy', 'joy', 'haha'],
description: 'grinning face with big eyes',
category: 'Smileys & Emotion'
},
{
emoji: '😄',
names: ['smile'],
tags: ['happy', 'joy', 'laugh', 'pleased'],
description: 'grinning face with smiling eyes',
category: 'Smileys & Emotion'
},
// …
]
nameToEmoji
Map of names (100
) to emoji (💯
) (Record<string, string>
).
import {nameToEmoji} from 'gemoji'
console.log(nameToEmoji.cat) //=> 🐱
console.log(nameToEmoji.poop) //=> 💩
emojiToName
Map of emoji (😀
) to names (grinning
) (Record<string, string>
).
import {emojiToName} from 'gemoji'
console.log(emojiToName['🐶']) //=> dog
console.log(emojiToName['\uD83D\uDCA9']) //=> hankey
This package is fully typed with TypeScript.
It exports an additional type Gemoji
.
See support.md
for what info is included.
The data is crawled from github/gemoji
and later processed for relevant
information.
No images are included in this repository: the copyrighted material may or may not be available on the users computer.
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.
This package is safe.
words/emoji-emotion
wooorm/emoticon
wooorm/strip-skin-tone
wooorm.com/checkmoji
Yes please! See How to Contribute to Open Source.
wooorm/gemoji
is not affiliated with GitHub.
See its github/gemoji
for info on GHs licensing.