# node-emojify

> Transform text into emojis 🚀

Latest version **0.0.15** (published 2019-08-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-emojify
pnpm add node-emojify
yarn add node-emojify
bun add node-emojify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2019-08-17 |
| First published | 2017-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.2.4 |
| Dependencies | 1 |
| Unpacked size | 12.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jesse Palmer |
| Maintainers | jesselpalmer |
| Keywords | emojis |

## Links

- npm: https://www.npmjs.com/package/node-emojify
- Repository: https://github.com/jesselpalmer/node-emojify
- Homepage: https://github.com/jesselpalmer/node-emojify#readme
- Issues: https://github.com/jesselpalmer/node-emojify/issues
- npm.io page: https://npm.io/package/node-emojify

## Dependencies (1)

- [node-emojis](https://npm.io/package/node-emojis.md) 0.0.2

## Recent versions

- 0.0.15 (latest) — 2019-08-17
- 0.0.14 — 2018-07-08
- 0.0.13 — 2018-07-08
- 0.0.12 — 2018-07-07
- 0.0.11 — 2018-07-05
- 0.0.10 — 2018-07-05
- 0.0.9 — 2017-06-16
- 0.0.8 — 2017-06-15
- 0.0.7 — 2017-06-14
- 0.0.6 — 2017-06-13
- 0.0.5 — 2017-06-12
- 0.0.4 — 2017-06-12
- 0.0.3 — 2017-06-12
- 0.0.2 — 2017-06-11
- 0.0.1 — 2017-06-11

## README

[![npm](https://img.shields.io/npm/dw/node-emojify.svg)](https://www.npmjs.com/package/node-emojify)
[![Build Status](https://travis-ci.org/jesselpalmer/node-emojify.svg?branch=master)](https://travis-ci.org/jesselpalmer/node-emojify)
[![Coverage Status](https://coveralls.io/repos/github/jesselpalmer/node-emojify/badge.svg?branch=master)](https://coveralls.io/github/jesselpalmer/node-emojify?branch=master)
[![dependencies Status](https://david-dm.org/jesselpalmer/node-emojify/status.svg)](https://david-dm.org/jesselpalmer/node-emojify)
[![devDependencies Status](https://david-dm.org/jesselpalmer/node-emojify/dev-status.svg)](https://david-dm.org/jesselpalmer/node-emojify?type=dev)

# node-emojify

Transform text into emojis 🚀.

## Goal

The goal of the project is to support all of the emojis that can be
found at [Emojipedia](https://emojipedia.org/). The shortcodess (ex. `:fire:`) that are supported are
the ones that can be found Emojipedia. If the shortcode isn't in Emojipedia, then the shortcode in
Slack are used. If the shortcode isn't in Slack, then the shortcode in GitHub is used. If the
shortcode cannot be found in Emojipedia, Slack, or GitHub, then the name of the emoji in Emojipedia is
used and underscores are used to concatenate multiple words.

## Support Status

Below is a table of the emojis that are supported by version. There may be some emojis that are
supported in the different verisons, but there hasn't been a concerted effort to add all emojis from
that version.

<table>
  <tr>
    <th>Verison</th>
    <th>Status</th>
  </tr>
  <tr>
    <td><a href=https://emojipedia.org/emoji-1.0/>Emoji 1.0</a></td>
    <td>In development 🙂</td> 
  </tr>
  <tr>
    <td><a href=https://emojipedia.org/emoji-2.0/>Emoji 2.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
  <tr>
     <td><a href=https://emojipedia.org/emoji-3.0/>Emoji 3.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
  <tr>
     <td><a href=https://emojipedia.org/emoji-4.0/>Emoji 4.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
  <tr>
    <td><a href=https://emojipedia.org/emoji-5.0/>Emoji 5.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
  <tr>
    <td><a href=https://emojipedia.org/emoji-11.0/>Emoji 11.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
  <tr>
     <td><a href=https://emojipedia.org/emoji-12.0/>Emoji 12.0</a></td>
    <td>Not supported yet 🙁</td>  
  </tr>
</table>

## Installation

  ```bash
  npm install node-emojify
  ```

## Usage

Text that you would like to convert into emojis must be surrounded by colons, like `:grinning:`.

  ```js
  const emojify = require('node-emojify')

  const sentence = emojify('node is :thumbsup:')

  console.log(sentence)
  ```

  Output should be `node is 👍`

  If the emoji isn't supported the text will simply be ignored and not be transformed.
  
### Supported emojis
  
  Supported emojis can be found in different files using the table below:
  
  <table>
    <tr>
      <th>Category</th>
      <th>Filename</th>
    </tr>
    <tr>
      <td>🐈 Animal</td>
      <td><a href="https://github.com/jesselpalmer/node-emojis/blob/master/lib/emojis/animal-emojis.js">animal-emojis.js</a></td>
    </tr>
    <tr>
      <td>🍔 Food</td>
      <td><a href="https://github.com/jesselpalmer/node-emojis/blob/master/lib/emojis/food-emojis.js">food-emojis.js</a></td>
    </tr>
    <tr>
      <td>🔥 Nature</td>
      <td><a href="https://github.com/jesselpalmer/node-emojis/blob/master/lib/emojis/nature-emojis.js">nature-emojis.js</a></td>
    </tr>
    <tr>
      <td>🙃 People</td>
      <td><a href="https://github.com/jesselpalmer/node-emojis/blob/master/lib/emojis/people-emojis.js">people-emojis.js</a></td>
    </tr>
    <tr>
      <td>🗻 Travel</td>
      <td><a href="https://github.com/jesselpalmer/node-emojis/blob/master/lib/emojis/travel-emojis.js">travel-emojis.js</a></td>
    </tr>
   </table>
  
  If there is an emoji that you need and is not available, please file an [issue](https://github.com/jesselpalmer/node-emojify/issues) or create a [pull request](https://github.com/jesselpalmer/node-emojify/pulls).
  
## Tests

  ```bash
  npm test
  ```

## Contributing

Pull requests are welcome! Please make sure that any new or changed functionality need to have unit tests accompanied with the PR. Make sure that you lint (`npm run lint`) and test your code (`npm test`).

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