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

A JavaScript implementation of the Ecoji encoding standard. Provides a simple API to encode or/and decode data as a base-1024 sequence of emoji symbols.

Installation

# 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

const ecoji = require('ecoji-js')
const str = 'Hello World'
ecoji.encode(str)

🏯🔩🚗🌷🍉👇🦒🕊👡☕☕☕

Decoding

const ecoji = require('ecoji-js')
const str = '🏯🔩🚗🌷🍉👇🦒🕊👡☕☕☕'
ecoji.decode(str)

Hello World

CLI

$ 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

Read more about standard by following above link.

License

This project is licensed under the terms of the Apache License 2.0.

dimabory / ecoji-js

readme