# gemoji

> GitHub emoji: gemoji

Latest version **8.1.0** (published 2023-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install gemoji
pnpm add gemoji
yarn add gemoji
bun add gemoji
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 8.1.0 |
| Published | 2023-03-29 |
| First published | 2014-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 352.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 255 |
| Author | Titus Wormer |
| Maintainers | wooorm |
| Keywords | gemoji, emoji, unicode, name, shortcode, tag, alias, name |

## Links

- npm: https://www.npmjs.com/package/gemoji
- Repository: https://github.com/wooorm/gemoji
- Homepage: https://github.com/wooorm/gemoji#readme
- Issues: https://github.com/wooorm/gemoji/issues
- Funding: https://github.com/sponsors/wooorm
- npm.io page: https://npm.io/package/gemoji

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 8.1.0 (latest) — 2023-03-29
- 8.0.0 — 2022-11-16
- 7.1.0 — 2021-11-05
- 7.0.0 — 2021-03-25
- 6.1.0 — 2020-10-13
- 6.0.0 — 2020-10-06
- 5.0.1 — 2020-04-11
- 5.0.0 — 2020-01-23
- 4.2.1 — 2018-04-29
- 4.2.0 — 2017-05-28
- 4.1.0 — 2017-02-24
- 4.0.0 — 2016-12-22
- 3.0.0 — 2016-11-27
- 2.0.1 — 2016-09-18
- 2.0.0 — 2016-09-18
- … 10 more at https://npm.io/package/gemoji/versions

## README

# gemoji

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

Info on gemoji.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`gemoji`](#gemoji-1)
    *   [`nameToEmoji`](#nametoemoji)
    *   [`emojiToName`](#emojitoname)
*   [Types](#types)
*   [Data](#data)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Related](#related)
*   [Contribute](#contribute)
*   [Notice](#notice)
*   [License](#license)

## What is this?

This package contains info on gemoji (**G**itHub **Emoji**).
Gemoji are the shortcodes that GitHub uses to represent emoji.
For example, `:grinning:` can be used for `😀`.

## When should I use this?

Use this package if you need:

*   info on gemoji, such as associated tags, description, and
    category
*   to map between emoji and names and vice versa
*   to list emoji or names

## Install

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

```sh
npm install gemoji
```

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

```js
import {gemoji} from 'https://esm.sh/gemoji@8'
```

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

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

## Use

See examples below.

## API

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`)
    — example: `😀`
*   `names` (`Array<string>`)
    — example: `['grinning']`
*   `tags` (`Array<string>`)
    — example: `['smile', 'happy']`
*   `description` (`string`)
    — example: `grinning face`
*   `category` (`string`)
    — example: `Smileys & Emotion`

###### Example

```js
import {gemoji} from 'gemoji'

console.log(gemoji)
```

Yields:

```js
[
  {
    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>`).

###### Example

```js
import {nameToEmoji} from 'gemoji'

console.log(nameToEmoji.cat) //=> 🐱
console.log(nameToEmoji.poop) //=> 💩
```

### `emojiToName`

Map of emoji (`😀`) to names (`grinning`) (`Record<string, string>`).

###### Example

```js
import {emojiToName} from 'gemoji'

console.log(emojiToName['🐶']) //=> dog
console.log(emojiToName['\uD83D\uDCA9']) //=> hankey
```

## Types

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

## Data

See [`support.md`][support] for what info is included.

The data is crawled from [`github/gemoji`][gh] 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.

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

*   [`words/emoji-emotion`](https://github.com/words/emoji-emotion)
    — list of emoji rated for valence
*   [`wooorm/emoticon`](https://github.com/wooorm/emoticon)
    — info on ASCII emoticons
*   [`wooorm/strip-skin-tone`](https://github.com/wooorm/strip-skin-tone)
    — strip skin-tones from emoji
*   [`wooorm.com/checkmoji`](https://wooorm.com/checkmoji/)
    — check emoji across platforms

## Contribute

Yes please!
See [How to Contribute to Open Source][contribute].

## Notice

`wooorm/gemoji` is not affiliated with **GitHub**.

See its [`github/gemoji`][gh-license] for info on GHs licensing.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[build-badge]: https://github.com/wooorm/gemoji/workflows/main/badge.svg

[build]: https://github.com/wooorm/gemoji/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/gemoji.svg

[coverage]: https://codecov.io/github/wooorm/gemoji

[downloads-badge]: https://img.shields.io/npm/dm/gemoji.svg

[downloads]: https://www.npmjs.com/package/gemoji

[size-badge]: https://img.shields.io/bundlephobia/minzip/gemoji.svg

[size]: https://bundlephobia.com/result?p=gemoji

[npm]: https://docs.npmjs.com/cli/install

[esmsh]: https://esm.sh

[license]: license

[author]: https://wooorm.com

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[typescript]: https://www.typescriptlang.org

[contribute]: https://opensource.guide/how-to-contribute/

[support]: support.md

[gh]: https://github.com/github/gemoji

[gh-license]: https://github.com/github/gemoji/blob/55a0080/LICENSE

---
_Source: https://npm.io/package/gemoji · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._