npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gemoji

v8.1.0

Published

GitHub emoji: gemoji

Downloads

383,133

Readme

gemoji

Build Coverage Downloads Size

Info on gemoji.

Contents

What is this?

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 😀.

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

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
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>).

Example
import {nameToEmoji} from 'gemoji'

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

emojiToName

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

Example
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 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.

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

Contribute

Yes please! See How to Contribute to Open Source.

Notice

wooorm/gemoji is not affiliated with GitHub.

See its github/gemoji for info on GHs licensing.

License

MIT © Titus Wormer