# eaze-codex

> Encode and decode Eaze invite codes

Latest version **1.0.0** (published 2015-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install eaze-codex
pnpm add eaze-codex
yarn add eaze-codex
bun add eaze-codex
```

Provides the command `codex`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-11-05 |
| First published | 2015-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | eaze, invite, code, user, id |

## Links

- npm: https://www.npmjs.com/package/eaze-codex
- Repository: https://github.com/eaze/codex
- Homepage: https://github.com/eaze/codex#readme
- Issues: https://github.com/eaze/codex/issues
- npm.io page: https://npm.io/package/eaze-codex

## Dependencies (3)

- [meow](https://npm.io/package/meow.md) ~3.5.0
- [bases](https://npm.io/package/bases.md) ~0.2.1
- [assert-equal](https://npm.io/package/assert-equal.md) ~1.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-11-05

## README

# codex [![Build Status](https://travis-ci.org/eaze/codex.svg?branch=master)](https://travis-ci.org/eaze/codex)

> Encode and decode Eaze invite codes


## Install

```
# API
$ npm install --save eaze-codex

# CLI
$ npm install --global eaze-codex
```


## Usage

```js
var codex = require('eaze-codex')

codex.encode(73061)
//=> icmmgd

codex.decode('icmmgd')
//=> 73061
```

```sh
$ codex encode 73061
#=> icmmgd

$ codex decode icmmgd
#=> 73061
```

## API

#### `codex.encode(id)` -> `string`

Returns an invite code.

##### id

*Required*  
Type: `number`

The user ID number.

#### `codex.decode(code)` -> `number`

Returns a user ID.

##### code

*Required*  
Type: `string`

## License

MIT © [Ben Drucker](http://bendrucker.me)

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