# lemoji

> Emoticons made using a series of symbols.

Latest version **0.1.0-0** (published 2022-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install lemoji
pnpm add lemoji
yarn add lemoji
bun add lemoji
```

Provides the command `lemoji`.

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-0 |
| Published | 2022-07-29 |
| First published | 2022-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 47.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jack-Zhang |
| Maintainers | jack-fw |
| Keywords | lemoji, emoji, unicode, name, shortcode, tag |

## Links

- npm: https://www.npmjs.com/package/lemoji
- Repository: https://github.com/Jack-Zhang-1314/lemoji
- Homepage: https://github.com/Jack-Zhang-1314/lemoji#readme
- Issues: https://github.com/Jack-Zhang-1314/lemoji/issues
- Funding: https://github.com/sponsors/Jack-Zhang-1314
- npm.io page: https://npm.io/package/lemoji

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.1.0-0 (latest) — 2022-07-29
- 0.0.2 — 2022-07-28
- 0.0.1 — 2022-07-28

## README

# lemoji

![npm bundle size](https://img.shields.io/bundlephobia/minzip/lemoji?logo=lemoji&logoColor=green&style=social)
![GitHub](https://img.shields.io/github/license/Jack-Zhang-1314/lemoji?style=social)
![npm](https://img.shields.io/npm/v/lemoji?style=social)

Emoticons made using a series of symbols.

## What is this?

This package contains emoji made with unicode characters.You can easliy use text (e.g. `:angry`) to type the emoji maybe you want (`ꐦ≖ ≖`).

## About lemoji

* it has associated tags, description, and category.
* it is built entirely with typescript.
* And this package is safe.

## who needs this bag?

* If you want to use emoji on an operating system that doesn't support graphics.
* Or you like them very much.  
* Or hope to use these emoji in your project.

## Install

This package supprts `esm` and `commonjs`. You can use `npm`, `yarn`, or `pnpm` to install this package.

>use npm

```sh
npm install lemoji
```

>use yarn

```sh
yarn add lemoji
```

> use pnpm

```sh
pnpm add lemoji
```

## How to use

>This package exports the following identifiers: `lemoji`, `nameToEmoji`, `emojiToName`.

### If you use commonjs, you can use `require` to import the identifiers

   ```js
   const { nameToEmoji } = require("lemoji")
   ```

### If you use esm, you can use `import` to import identifiers

   ```js
   import { nameToEmoji } from "lemoji"
   ```

### API

>`lemoji`: it is a objects (`Ilemoji[]`).Every `lemoji` has the following fields:

   ```ts
   {
     name: string;
     emoji: string;
     tags: string[];
     description: string;
     category: string;
   }
   ```

* Example

   ```js
   import {lemoji} from 'lemoji'

   console.log(lemoji)
   ```

* fields:

  ```js
  [
   {
     "emoji": "(·•᷄ࡇ•᷅ ）",
     "names": ["tangled"],
     "tags": ["frustrated","unhappy"],
     "description": "tangled face",
     "category": "Smileys & Emotion"
   },
   {
     "emoji": "(◍•ᴗ•◍)",
     "names": ["smiley"],
     "tags": ["happy","joy","haha"],
     "description": "grinning face",
     "category": "Smileys & Emotion"
   },
   //...
  ]
  ```

>`nameToEmoji`: it is a objects (`InameToEmoji`).Every `nameToEmoji` has the following fields:

   ```ts
   {
     [name: string]: string;
   }
   ```

* use `esm`

   ```js
   const { nameToEmoji } = require("lemoji")

   console.log(nameToEmoji.angry)//ꐦ≖ ≖
   console.log(nameToEmoji.happy)//(•̀ᴗ• )
   ```

* use `commonjs`

   ```js
  const { nameToEmoji } = require("lemoji")

  console.log(nameToEmoji.angry)//ꐦ≖ ≖
  console.log(nameToEmoji.happy)//(•̀ᴗ• )
   ```

>`emojiToName`: it is a objects (`IemojiToName`).Every `emojiToName` has the following fields:

   ```ts
   {
     [emoji: string]: string;
   }
   ```

* use `esm`:

   ```js
   import { emojiToName } from "lemoji"

   console.log(emojiToName["(*^_^*)"])//smile
   console.log(emojiToName["(\xB7\u2022\u1DC4\u0847\u2022\u1DC5 \uFF09"])//tangled
   ```

* use `commonjs`:

   ```js
   const { emojiToName } = require("lemoji")

   console.log(emojiToName["ꐦ≖ ≖"])//angry
   ```

## use cli to search name

> if you want to know wether there is this name, or want to contribute an emoji, you can use it.

* if you don't have a global download

   ```js
    npx lemoji -n happy
    //The name is already there (happy), and its emoji is((•̀ᴗ• )) please rename it
   ```

* if you have a global download, you can directly use.

   ```js
   lemoji -n happy
   ```

## License

[MIT](LICENSE)

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