{"id":13548696,"url":"https://github.com/wooorm/gemoji","last_synced_at":"2025-05-16T01:05:37.211Z","repository":{"id":17869335,"uuid":"20804672","full_name":"wooorm/gemoji","owner":"wooorm","description":"Info on gemoji (GitHub Emoji)","archived":false,"fork":false,"pushed_at":"2023-11-01T11:36:42.000Z","size":923,"stargazers_count":251,"open_issues_count":0,"forks_count":63,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-08T12:06:01.161Z","etag":null,"topics":["emoji","gemoji","github"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wooorm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":"funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"wooorm"}},"created_at":"2014-06-13T13:17:19.000Z","updated_at":"2025-05-06T01:52:59.000Z","dependencies_parsed_at":"2022-07-13T05:30:29.733Z","dependency_job_id":"a5427957-8a94-4c28-b18c-f79ed2ca37c7","html_url":"https://github.com/wooorm/gemoji","commit_stats":{"total_commits":173,"total_committers":3,"mean_commits":"57.666666666666664","dds":"0.011560693641618491","last_synced_commit":"95b8d4669ce0b67ad6cfe09632c0515b9b0e01e2"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgemoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgemoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgemoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgemoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wooorm","download_url":"https://codeload.github.com/wooorm/gemoji/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448579,"owners_count":22072764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emoji","gemoji","github"],"created_at":"2024-08-01T12:01:13.328Z","updated_at":"2025-05-16T01:05:32.195Z","avatar_url":"https://github.com/wooorm.png","language":"JavaScript","funding_links":["https://github.com/sponsors/wooorm"],"categories":["JavaScript","github"],"sub_categories":[],"readme":"# gemoji\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n\nInfo on gemoji.\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`gemoji`](#gemoji-1)\n    *   [`nameToEmoji`](#nametoemoji)\n    *   [`emojiToName`](#emojitoname)\n*   [Types](#types)\n*   [Data](#data)\n*   [Compatibility](#compatibility)\n*   [Security](#security)\n*   [Related](#related)\n*   [Contribute](#contribute)\n*   [Notice](#notice)\n*   [License](#license)\n\n## What is this?\n\nThis package contains info on gemoji (**G**itHub **Emoji**).\nGemoji are the shortcodes that GitHub uses to represent emoji.\nFor example, `:grinning:` can be used for `😀`.\n\n## When should I use this?\n\nUse this package if you need:\n\n*   info on gemoji, such as associated tags, description, and\n    category\n*   to map between emoji and names and vice versa\n*   to list emoji or names\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 14.14+, 16.0+), install with [npm][]:\n\n```sh\nnpm install gemoji\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {gemoji} from 'https://esm.sh/gemoji@8'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import {gemoji} from 'https://esm.sh/gemoji@8?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\nSee examples below.\n\n## API\n\nThis package exports the identifiers `gemoji`, `emojiToName`, and\n`nameToEmoji`.\nThere is no default export.\n\n### `gemoji`\n\nList of info objects (`Array\u003cGemoji\u003e`).\nEach `Gemoji` has the following fields:\n\n*   `emoji` (`string`)\n    — example: `😀`\n*   `names` (`Array\u003cstring\u003e`)\n    — example: `['grinning']`\n*   `tags` (`Array\u003cstring\u003e`)\n    — example: `['smile', 'happy']`\n*   `description` (`string`)\n    — example: `grinning face`\n*   `category` (`string`)\n    — example: `Smileys \u0026 Emotion`\n\n###### Example\n\n```js\nimport {gemoji} from 'gemoji'\n\nconsole.log(gemoji)\n```\n\nYields:\n\n```js\n[\n  {\n    emoji: '😀',\n    names: ['grinning'],\n    tags: ['smile', 'happy'],\n    description: 'grinning face',\n    category: 'Smileys \u0026 Emotion'\n  },\n  {\n    emoji: '😃',\n    names: ['smiley'],\n    tags: ['happy', 'joy', 'haha'],\n    description: 'grinning face with big eyes',\n    category: 'Smileys \u0026 Emotion'\n  },\n  {\n    emoji: '😄',\n    names: ['smile'],\n    tags: ['happy', 'joy', 'laugh', 'pleased'],\n    description: 'grinning face with smiling eyes',\n    category: 'Smileys \u0026 Emotion'\n  },\n  // …\n]\n```\n\n### `nameToEmoji`\n\nMap of names (`100`) to emoji (`💯`) (`Record\u003cstring, string\u003e`).\n\n###### Example\n\n```js\nimport {nameToEmoji} from 'gemoji'\n\nconsole.log(nameToEmoji.cat) //=\u003e 🐱\nconsole.log(nameToEmoji.poop) //=\u003e 💩\n```\n\n### `emojiToName`\n\nMap of emoji (`😀`) to names (`grinning`) (`Record\u003cstring, string\u003e`).\n\n###### Example\n\n```js\nimport {emojiToName} from 'gemoji'\n\nconsole.log(emojiToName['🐶']) //=\u003e dog\nconsole.log(emojiToName['\\uD83D\\uDCA9']) //=\u003e hankey\n```\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports an additional type `Gemoji`.\n\n## Data\n\nSee [`support.md`][support] for what info is included.\n\nThe data is crawled from [`github/gemoji`][gh] and later processed for relevant\ninformation.\n\nNo images are included in this repository: the copyrighted material may or may\nnot be available on the users computer.\n\n## Compatibility\n\nThis package is at least compatible with all maintained versions of Node.js.\nAs of now, that is Node.js 14.14+ and 16.0+.\nIt also works in Deno and modern browsers.\n\n## Security\n\nThis package is safe.\n\n## Related\n\n*   [`words/emoji-emotion`](https://github.com/words/emoji-emotion)\n    — list of emoji rated for valence\n*   [`wooorm/emoticon`](https://github.com/wooorm/emoticon)\n    — info on ASCII emoticons\n*   [`wooorm/strip-skin-tone`](https://github.com/wooorm/strip-skin-tone)\n    — strip skin-tones from emoji\n*   [`wooorm.com/checkmoji`](https://wooorm.com/checkmoji/)\n    — check emoji across platforms\n\n## Contribute\n\nYes please!\nSee [How to Contribute to Open Source][contribute].\n\n## Notice\n\n`wooorm/gemoji` is not affiliated with **GitHub**.\n\nSee its [`github/gemoji`][gh-license] for info on GHs licensing.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/wooorm/gemoji/workflows/main/badge.svg\n\n[build]: https://github.com/wooorm/gemoji/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/gemoji.svg\n\n[coverage]: https://codecov.io/github/wooorm/gemoji\n\n[downloads-badge]: https://img.shields.io/npm/dm/gemoji.svg\n\n[downloads]: https://www.npmjs.com/package/gemoji\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/gemoji.svg\n\n[size]: https://bundlephobia.com/result?p=gemoji\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esmsh]: https://esm.sh\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[typescript]: https://www.typescriptlang.org\n\n[contribute]: https://opensource.guide/how-to-contribute/\n\n[support]: support.md\n\n[gh]: https://github.com/github/gemoji\n\n[gh-license]: https://github.com/github/gemoji/blob/55a0080/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fgemoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwooorm%2Fgemoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fgemoji/lists"}