# easecrypto

> cipher/decipher files and private keys easily

Latest version **1.0.2** (published 2022-11-14) · ISC license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2022-11-14 |
| First published | 2022-01-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mehdi Jai |
| Maintainers | medostudios |
| Keywords | encrypt, cipher, encryption, decrypt, Decryption, decipher |

## Links

- npm: https://www.npmjs.com/package/easecrypto
- Repository: https://github.com/mehdijai/easecryptor
- Issues: https://github.com/mehdijai/easecryptor/issues
- npm.io page: https://npm.io/package/easecrypto

## Dependencies (1)

- [crypto-js](https://npm.io/package/crypto-js.md) ^4.1.1

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-11-14
- 1.0.1 — 2022-01-01
- 1.0.0 — 2022-01-01

## README

# Easecrypto package

A package to help you encrypt/decrypt files and strings with simple functions

## Installation

Install via npm

``` bash
    $ npm install easecrypto
```

## How to use


import the functions you need

``` js
    const {fileEncryptor, fileDecryptor, keyEncryptor, keyDecryptor} = require('easecrypto')
```

## Functions

### File Encryptor

#### Example
``` js
    fileEncryptor('./src.json', './dist.ms', privateKey,'r', ((data, err) => {
        if(err){
            console.error(err);
        }else{
            console.log(data);
        }
    }))
```

#### Functions parameters

<ul>
    <li><strong>source path</strong> the path of the file to encrypt</li>
    <li><strong>destination path</strong> the path, name and extension of the created file</li>
    <li><strong>encryption key</strong> private key to encrypt the file and decrypt it</li>
    <li><strong>flag</strong> <em>null or 'r'</em> If the destination file already exists, the encryption will stop and returns an error. However, if you wont to overwrite it pass 'r' into the parameter.</li>
    <li><strong>callback</strong> this function is asynchronous. the callback contains err and success message to make sure the process went fine.</li>
</ul>

#### Troubleshooting

make sure you pass the flag parameter! pass 'r' or null. Otherwise it will throw an error.

``` js
    fileEncryptor('./src.json', './dist.ms', privateKey,null, ((data, err) => {
        if(err){
            console.error(err);
        }else{
            console.log(data);
        }
    }))
```


### File Decryptor

#### Example
``` js
    fileDecryptor('./dist.ms', './new.json', privateKey, (res => {
        console.log(res);
    }))
```

#### Functions parameters

<ul>
    <li><strong>source path</strong> the path of the file to decrypt</li>
    <li><strong>destination path</strong> <em>null or path</em> the path, name and extension of the created file. if the value is null. the callback res will return the content without writing a file to include the data.</li>
    <li><strong>encryption key</strong> private key to encrypt the file and decrypt it</li>
    <li><strong>callback</strong> this function is asynchronous. the callback contains a success message or the content of the file if destination file is set to null</li>
</ul>

#### Troubleshooting

make sure you pass the destination path parameter! either a path value or null. Otherwise it will throw an error.

``` js
    fileDecryptor('./dist.ms', null, privateKey, (res => {
        console.log(res);
    }))
```

### Key Encryptor

#### Example
``` js
    const encryptedKey = keyEncryptor("secret password", privateKey)
```

#### Functions parameters

<ul>
    <li><strong>key</strong> the string value to encrypt</li>
    <li><strong>encryption key</strong> private key to encrypt the text and decrypt it</li>
</ul>

### Key Decryptor

#### Example
``` js
    const decryptedKey = keyDecryptor(encryptedKey, privateKey)
```

#### Functions parameters

<ul>
    <li><strong>encrypted key</strong> the encrypted string value to decrypt</li>
    <li><strong>encryption key</strong> private key to encrypt the text and decrypt it</li>
</ul>

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