# @pixim/emoji

> Pixiv's custom emoji converter

Latest version **0.0.4** (published 2018-12-20) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @pixim/emoji
pnpm add @pixim/emoji
yarn add @pixim/emoji
bun add @pixim/emoji
```

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2018-12-20 |
| First published | 2018-11-28 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 42.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | neetshin |

## Links

- npm: https://www.npmjs.com/package/@pixim/emoji
- Repository: https://github.com/piximhq/emoji
- Homepage: https://github.com/piximhq/emoji#readme
- Issues: https://github.com/piximhq/emoji/issues
- npm.io page: https://npm.io/package/@pixim/emoji

## Recent versions

- 0.0.4 (latest) — 2018-12-20
- 0.0.3 — 2018-12-03
- 0.0.2 — 2018-11-28
- 0.0.1 — 2018-11-28

## README

# @pixim/emoji
[![npm](https://img.shields.io/npm/v/@pixim/emoji.svg)](https://www.npmjs.com/package/@pixim/emoji)

Pixiv's custom emoji converter

## Installation
```
npm i @pixim/emoji --save
```
<a href='https://www.patreon.com/neetshin'><img src='https://c5.patreon.com/external/logo/become_a_patron_button.png' alt='Become a patron' width='140px' /></a>

## Usage
### `emoijfy`
Convert emoji keywords (e.g. `(heart)`) to HTML img elements.
```ts
import { emojify } from '@pixim/emoji';

emojify('I like this! (heart)');
// -> 'I like this! <img class="__pixiv-emoji" src="https://s.pximg.net/common/images/emoji/501.png" alt="heart" title="heart">'
```

### `stringify`
The contrary of `emojify`
```ts
import { stringify } from '@pixim/emoji';

stringify('I like this! <img class="__pixiv-emoji" src="https://s.pximg.net/common/images/emoji/501.png" alt="heart" title="heart">');
// -> 'I like this! (heart)'
```

## License
AGPL v3

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