https://github.com/andrewn/emoji-describe

Replace emoji in strings with a description
https://github.com/andrewn/emoji-describe

Last synced: 23 days ago
JSON representation

Replace emoji in strings with a description

• Host: GitHub
• URL: https://github.com/andrewn/emoji-describe
• Owner: andrewn
• Created: 2018-03-12T22:05:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-03-13T10:30:05.000Z (over 8 years ago)
• Last Synced: 2025-08-09T05:32:49.379Z (11 months ago)
• Language: JavaScript
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# emoji-describe

Replaces emoji characters in strings with their names.

For example:

    const replaceInString = require('emoji-describe');

    replaceInString("I hope this works 🤞");

    // Returns:

    //   "I hope this works hand with index and middle fingers crossed"

It handles skin tone variants using the same language as Apple's excellent accessibility.

## Install

    npm install --save emoji-describe

## Development

The data is fetched from [`iamcal/emoji-data`](https://github.com/iamcal/emoji-data) and processed into a simple emoji -> description lookup.

To fetch and transform the latest data:

    git clone 

    cd emoji-name

    npm install

    npm run build