# i-encrypt

> Encryption / Decryption made simple

Latest version **1.0.1** (published 2016-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install i-encrypt
pnpm add i-encrypt
yarn add i-encrypt
bun add i-encrypt
```

## 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.1 |
| Published | 2016-09-28 |
| First published | 2016-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Skevos Papamichail |
| Maintainers | skpapam |
| Keywords | encrypt, decrypt, security, crypto, hmac |

## Links

- npm: https://www.npmjs.com/package/i-encrypt
- Repository: https://github.com/skpapam/i-encrypt
- Homepage: https://github.com/skpapam/i-encrypt#readme
- Issues: https://github.com/skpapam/i-encrypt/issues
- npm.io page: https://npm.io/package/i-encrypt

## Dependencies (1)

- [i-compare-strings](https://npm.io/package/i-compare-strings.md) ^1.0.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.1 (latest) — 2016-09-28
- 1.0.0 — 2016-09-26

## README

# i-encrypt

Encryption / Decryption made simple

## Installation

```bash
	npm install i-encrypt -save
```

## API 

**Require**
```js
	var ie = require('i-encrypt')(options);
```

**Options can be**
```js
	{
		//The encryption key by default is set to a random generated key
		key:"A secure secret string", 

		//Debug mode switcher by default is false
		debug:true
	}
```

* **ie.encrypt(data)** Will encrypt the given data. The data bust be any object or string or number. 
Will return the encrypted text or null on fail. 

* **ie.decrypt(text)** Will decrypt the given text. Will return an object, a string, a number or null on fail.

* **ie.sign(data, format)** Will generate an hmac signature for the given data. 
The data must be any object or string or number.
The format is the format of the generated signature by default is *'base64'*.
Will return the signature or null on fail.

* **ie.validate(data, signature, format)** Validate data's signature. Will return boolean. 

## LICENSE 
MIT

Copyright (c) 2016 Skevos Papamichail <contact@skevosp.me> (www.skevosp.me)

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