# o-ecoji-js

> Encodes and/or decodes data as emojis. Implementation of the Ecoji Standard. Its base1024 with an emoji character set.

Latest version **1.1.4** (published 2019-02-08) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install o-ecoji-js
pnpm add o-ecoji-js
yarn add o-ecoji-js
bun add o-ecoji-js
```

Provides the command `ecoji`.

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2019-02-08 |
| First published | 2019-02-08 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 2 |
| Unpacked size | 70.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Dmytro Borysovskyi |
| Maintainers | projectoblio |
| Keywords | emoji, ecoji, ecoji-js, base1024, algo |

## Links

- npm: https://www.npmjs.com/package/o-ecoji-js
- Repository: https://github.com/dimabory/ecoji-js
- Homepage: https://github.com/dimabory/ecoji-js#readme
- Issues: https://github.com/dimabory/ecoji-js/issues
- npm.io page: https://npm.io/package/o-ecoji-js

## Dependencies (2)

- [yargs](https://npm.io/package/yargs.md) 12.0.1
- [get-stdin](https://npm.io/package/get-stdin.md) 6.0.0

## Recent versions

- 1.1.4 (latest) — 2019-02-08

## README

# ecoji-js | 1️⃣0️⃣2️⃣4️⃣  👨‍💻🔥#️⃣🌎🛫🕶️

[![npm version](https://badge.fury.io/js/ecoji-js.svg)](https://www.npmjs.com/package/ecoji-js)
[![Build Status](https://travis-ci.com/dimabory/ecoji-js.svg?branch=master)](https://travis-ci.com/dimabory/ecoji-js)
[![codecov](https://codecov.io/gh/dimabory/ecoji-js/branch/master/graph/badge.svg)](https://codecov.io/gh/dimabory/ecoji-js)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

A JavaScript implementation of the [Ecoji](https://github.com/keith-turner/ecoji) encoding standard. Provides a simple API to encode or/and decode data as a base-1024 sequence of emoji symbols.

## Installation

```bash
# globally
$ npm i -g ecoji-js
$ ecoji -h

# locally
$ npm i -S ecoji-js
$ ./node_modules/.bin/ecoji -h
```

## Usage

The library provides two public methods to encode and/or decode data: 
* `encode(str: string): string`
* `decode(str: string): string`

### Encoding
```js
const ecoji = require('ecoji-js')
const str = 'Hello World'
ecoji.encode(str)
```
```
🏯🔩🚗🌷🍉👇🦒🕊👡☕☕☕
```
### Decoding
```js
const ecoji = require('ecoji-js')
const str = '🏯🔩🚗🌷🍉👇🦒🕊👡☕☕☕'
ecoji.decode(str)
```
```
Hello World
```
### CLI

```bash
$ ecoji -h
Usage: ecoji [-d]

Encode or decode data as Unicode emojis. 😁

Commands:
  ecoji -d  decode emoji to string

Options:
  -d, --decode   decode data                          [boolean] [default: false]
  --version, -v  Show version number                                   [boolean]
  --help, -h     Show help                                             [boolean]

Examples:
  echo -n 123 | ./bin/ecoji
  echo 🎌🚟🎈☕ | ./bin/ecoji -d

```
## [Ecoji encoding standard](https://github.com/keith-turner/ecoji/blob/master/docs/encoding.md)
Read more about standard by following above link.

## License
This project is licensed under the terms of the [Apache License 2.0](LICENSE).

Copyright (©️) 2019 Dmytro Borysovskyi

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