# encon

> (optionally) encrypted object notation

Latest version **0.0.1** (published 2020-11-07) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2020-11-07 |
| First published | 2020-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Frankie Bagnardi |
| Maintainers | greenjello |

## Links

- npm: https://www.npmjs.com/package/encon
- Repository: https://github.com/brigand/encon
- Homepage: https://github.com/brigand/encon/tree/master/encon-js
- Issues: https://github.com/brigand/encon/issues
- npm.io page: https://npm.io/package/encon

## Recent versions

- 0.0.1 (latest) — 2020-11-07

## README

Encon is an optionally-encrypted config format, built on top of JSON.

## Install

```sh
npm install encon

# or
yarn add encon
```

## Usage (high level)

TODO: implement and document.

## Usage (low level)

```js
const { Password } = require('encon');

let pass = new Password('strongpassword');

pass.encrypt(Buffer.from('Hello, world!')).then(encrypted => {
  console.log(encrypted.toString('hex'));

  pass.decrypt(encrypted).then(plainBuffer => {
    let plain = plainBuffer.toString();
    console.log(plain); // 'Hello, world!'
  });
});
```

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