# @yzfe/litemoji

> Js implementation of litemoji

Latest version **0.0.3** (published 2022-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @yzfe/litemoji
pnpm add @yzfe/litemoji
yarn add @yzfe/litemoji
bun add @yzfe/litemoji
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-11-09 |
| First published | 2022-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 179 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | vfasky |
| Maintainers | allenice, allenmo, vfasky |

## Links

- npm: https://www.npmjs.com/package/@yzfe/litemoji
- npm.io page: https://npm.io/package/@yzfe/litemoji

## Dependencies (1)

- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.6.3

## Recent versions

- 0.0.3 (latest) — 2022-11-09
- 0.0.2 — 2022-11-09
- 0.0.1 — 2022-10-09

## README

# LitEmoji 🔥

js implementation of [LitEmoji](https://github.com/elvanto/litemoji)

## Installation

```
yarn add @yzfe/litemoji
```

## Usage

```ts
import * as litemoji from '@yzfe/litemoji'

console.log(litemoji.encodeShortcode('Baby you light my 🔥! 😃'))
// 'Baby you light my :fire:! :smiley:'
console.log(litemoji.encodeHtml('Baby you light my :fire:! :smiley:'))
// 'Baby you light my 🔥! 😃'
console.log(litemoji.encodeUnicode('Baby you light my :fire:! :smiley:'))
// 'Baby you light my 🔥! 😃'
console.log(litemoji.removeEmoji('Baby you light my 🔥! 😃!!!'))
// 'Baby you light my ! !!!'
```

# Configuration

```ts
import * as litemoji from '@yzfe/litemoji'

// Exclude specific shortcodes when converting from unicode and HTML entities
litemoji.config('excludeShortcodes', ['mobile', 'android']))

console.log(litemoji.encodeShortcode('📱'))
// ':iphone:'
```

## Contributing

Pull requests are welcome.

## License

[MIT License](LICENSE)

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