# brokenjs

> A simple module for encrypting data

Latest version **1.0.5** (published 2018-05-08) · ISC license · 0 weekly downloads

## Install

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

## 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.5 |
| Published | 2018-05-08 |
| First published | 2018-05-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | adelmojnr |
| Maintainers | adelmojnr |

## Links

- npm: https://www.npmjs.com/package/brokenjs
- Repository: https://github.com/adelmojnr/broken.js
- Homepage: https://github.com/adelmojnr/broken.js#readme
- Issues: https://github.com/adelmojnr/broken.js/issues
- npm.io page: https://npm.io/package/brokenjs

## Recent versions

- 1.0.5 (latest) — 2018-05-08
- 1.0.4 — 2018-05-08
- 1.0.3 — 2018-05-08
- 1.0.2 — 2018-05-08
- 1.0.1 — 2018-05-08

## README

# How to use?

```bash
$ npm i brokenjs
```
For encrypting data:

```javascript
const broken = require('brokenjs')

broken.encrypt('test_encrypt_music_with_brokenjs',
               'broken_js_teste1',
               'music.mp3',
               'encrypted.mp3')
```
## Docs

### .encrypt(password, iv, fileSource, fileOutput)

**Parameter**: `password` **Type**: `String` **Ex**: `test_encrypt_music_with_brokenjs`

**Parameter**:  `iv` **Type**: `String` **Ex**:`broken_js_teste1`

**Parameter**: `fileSource` **Type**: `String` **Ex**: `music.mp3`

**Parameter**: `fileOutput` **Type**: ` String` **Ex**:`encrypted.mp3`

For decrypting data:

```javascript
const broken = require('brokenjs')

broken.decrypt('test_encrypt_music_with_brokenjs',
               'broken_js_teste1',
               'encrypted.mp3',
               'music.mp3')
```
## Docs

### .decrypt(password, iv, fileSource, fileOutput)

**Parameter**: `password` **Type**:  String` `**Ex**:`test_encrypt_music_with_brokenjs`

**Parameter**: `iv` **Type**: `String` **Ex**:`broken_js_teste1`

**Parameter**: `fileSource` **Type**:  `String` **Ex**: `encrypted.mp3`

**Parameter**:  `fileOutput` **Type**:  `String` **Ex**: `music.mp3`

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