{"id":15387256,"url":"https://github.com/rhysd/node-github-emoji","last_synced_at":"2025-04-15T17:32:38.449Z","repository":{"id":33581450,"uuid":"159661538","full_name":"rhysd/node-github-emoji","owner":"rhysd","description":"Node.js library for GitHub Emoji :octocat: with TypeScript support","archived":false,"fork":false,"pushed_at":"2023-03-02T14:04:35.000Z","size":1307,"stargazers_count":21,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T14:12:21.249Z","etag":null,"topics":["emoji","github","javascript","node","npm"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/rhysd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-29T12:17:01.000Z","updated_at":"2025-02-06T14:22:09.000Z","dependencies_parsed_at":"2024-06-18T21:32:19.262Z","dependency_job_id":"157a2606-04d2-4941-8225-5e5dbda2d903","html_url":"https://github.com/rhysd/node-github-emoji","commit_stats":{"total_commits":56,"total_committers":3,"mean_commits":"18.666666666666668","dds":0.2142857142857143,"last_synced_commit":"e52269cf67d0adcfba36b2b614073bc00c8c4f40"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fnode-github-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fnode-github-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fnode-github-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fnode-github-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhysd","download_url":"https://codeload.github.com/rhysd/node-github-emoji/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249118895,"owners_count":21215637,"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","github","javascript","node","npm"],"created_at":"2024-10-01T14:53:03.470Z","updated_at":"2025-04-15T17:32:38.082Z","avatar_url":"https://github.com/rhysd.png","language":"TypeScript","readme":"GitHub Emoji Library for Node.js typed with TypeScript\n======================================================\n[![npm version][]][npm]\n[![codecov badge][]][codecov]\n[![travis badge][]][travis]\n[![appveyor badge][]][appveyor]\n\nSmall [npm package](https://www.npmjs.com/package/github-emoji) for GitHub Emoji typed with TypeScript.\n\nFeatures:\n\n- Get properties of each emoji\n  - Name (e.g. `dog`)\n  - URL (e.g. `https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8`)\n  - String (e.g. `🐶`)\n  - File path to emoji file (e.g. `/path/to/github-emoji/images/1f436.png`)\n  - File name (e.g. `1f436.png`)\n- TypeScript ready\n  - Emoji name is typed as a union of string literal types. Compiler can check emoji name is correct.\n- Zero runtime dependency\n\nInstallation:\n\n```\nnpm install --save github-emoji\n```\n\nUsage:\n\n```javascript\nconst emoji = require('github-emoji');\n\nconsole.log('All emoji information as Map',             emoji.all());           // Map{ '+1' =\u003e {...}, ... }\nconsole.log('Get properties of emoji as object',        emoji.of('dog'));       // { string: '🐶', ... }\nconsole.log('Get emoji string from name',               emoji.stringOf('dog')); // '🐶'\nconsole.log('Get all emoji names from emoji string',    emoji.namesOf('👍'));   // ['+1', 'thumbsup']\nconsole.log('Get one of emoji names from emoji string', emoji.nameOf('👍'));    // '+1'\nconsole.log('Get emoji URL from name',                  emoji.urlOf('dog'));    // 'https://...'\nconsole.log('Check the string is emoji name',           emoji.isName('dog'));   // true\nconsole.log('Check the string is emoji',                emoji.isEmoji('🐶'));   // true\nconsole.log('Object of name =\u003e URL',                    emoji.URLS);            // { '+1': 'https://...', ... }\n```\n\nThis library is ready for [TypeScript](https://www.typescriptlang.org/).\n\n```typescript\nimport * as emoji from 'github-emoji';\n\nemoji.of('dog');   // OK\nemoji.of('doggo'); // COMPILE ERROR!\n\n// If you want to use string value for emoji name, please assert the string value\n// is emoji name using `as`.\nimport {EmojiName} from 'github-emoji';\nconst someName: string = ...;\nemoji.of(someName as EmojiName); // OK\n```\n\nPlease see `github-emoji/index.d.ts` for all APIs.\n\nYou may need to add `--resolveJsonModule` to `tsc` or `\"resolveJsonModule\": true` in `compilerOptions`\nsection of `tsconfig.json` to compile this library. `--outDir` would be also necessary in compile\nconfiguration. `--target` must be `es2015` or later.\n\nFor example:\n\n```\ntsc your_source.ts --resolveJsonModule --target es2015 --esModuleInterop --moduleResolution node --module commonjs\n```\n\n\n[npm version]: https://badge.fury.io/js/github-emoji.svg\n[npm]: https://www.npmjs.com/package/github-emoji\n[travis badge]: https://travis-ci.org/rhysd/node-github-emoji.svg?branch=master\n[travis]: https://travis-ci.org/rhysd/node-github-emoji\n[appveyor badge]: https://ci.appveyor.com/api/projects/status/xaq1x7rid0ikbixq/branch/master?svg=true\n[appveyor]: https://ci.appveyor.com/project/rhysd/node-github-emoji/branch/master\n[codecov badge]: https://codecov.io/gh/rhysd/node-github-emoji/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/rhysd/node-github-emoji\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fnode-github-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhysd%2Fnode-github-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fnode-github-emoji/lists"}