# emoji-strip

> Strip emoji from a string in Node.js and browsers.

Latest version **1.0.1** (published 2017-03-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install emoji-strip
pnpm add emoji-strip
yarn add emoji-strip
bun add emoji-strip
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-03-10 |
| First published | 2014-07-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/emoji-strip) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 75 |
| Author | Nizar Khalife Iglesias |
| Maintainers | khalifenizar |
| Keywords | emoji, strip, remove, emoticons |

## Links

- npm: https://www.npmjs.com/package/emoji-strip
- Repository: https://github.com/khalifenizar/emoji-strip
- Issues: https://github.com/khalifenizar/emoji-strip/issues
- npm.io page: https://npm.io/package/emoji-strip

## Dependencies (1)

- [emoji-regex](https://npm.io/package/emoji-regex.md) ^6.1.3

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-03-10
- 1.0.0 — 2017-03-05
- 0.0.3 — 2014-07-19
- 0.0.2 — 2014-07-15
- 0.0.1 — 2014-07-15

## README

emoji-strip
===========

Use [`emoji-regex`](https://github.com/mathiasbynens/emoji-regex)
to Strip emoji from a string in Node.js and browsers.


Examples
--------

```js
var emoji

emoji = 'thumbs-up👍 for staying strong💪 without emoji please🙏'
console.log(emojiStrip(emoji))
// => "thumbs-up for staying strong without emoji please"

emoji = 'dealing with emoji😡 makes me feel like poop💩'
console.log(emojiStrip(emoji))
// => "dealing with emoji makes me feel like poop"
```


API
---

### emojiStrip(string) ###

Returns a copy of `string` with any emoji characters removed.


Supported emoji
---------------

The `emojiStrip` function uses
the [`emoji-regex`](https://www.npmjs.org/package/emoji-regex) package
behind the scenes.
It can remove any of the emoji supported by that package.

Currently, it supports all emoji up to
[Unicode Version 10](http://emojipedia.org/unicode-10.0/)
except for emoji sequences.


Install
-------

### For Node.js ###

Install with [npm](https://www.npmjs.org/):
```bash
npm install --save emoji-strip
```

Require it in your program:
```js
var emojiStrip = require('emoji-strip')
```

### For browsers ###

Download one of the versions of `emoji-strip.js`:
- [emoji-strip.js](https://raw.githubusercontent.com/khalifenizar/emoji-strip/master/dist/emoji-strip.js) (uncompressed)
- [emoji-strip.min.js](https://raw.githubusercontent.com/khalifenizar/emoji-strip/master/dist/emoji-strip.min.js) (minified)

Link it in your HTML:
```html
<script src="emoji-strip.min.js"></script>
```


License
-------

ISC

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