# wmt-encryption-module

> Typescript node module for data encryption

Latest version **1.0.0** (published 2019-01-17) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install wmt-encryption-module
pnpm add wmt-encryption-module
yarn add wmt-encryption-module
bun add wmt-encryption-module
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-01-17 |
| First published | 2019-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 326.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Joshua Clark WMTP |
| Maintainers | wmt-sdk |

## Links

- npm: https://www.npmjs.com/package/wmt-encryption-module
- Repository: https://gitlab.com/joshua.clark/typescript-node-module-boilerplate
- Homepage: https://bitbucket.org/wmtp/wmt-encryption-module/src/master/
- Issues: https://gitlab.com/joshua.clark/typescript-node-module-boilerplate/issues
- npm.io page: https://npm.io/package/wmt-encryption-module

## Dependencies (2)

- [blockstack](https://npm.io/package/blockstack.md) ^18.2.1
- [@types/node](https://npm.io/package/@types/node.md) ^10.12.18

## Recent versions

- 1.0.0 (latest) — 2019-01-17

## README

# WMTP Encryption Module
The WMTP encryption module provides aes-256-gcm encryption for node.js applications
## Setting up the module
  - clone the repository
  - run "npm install" to install dependencies needed to run
## Building the module
The module uses Typescript compiler (TSC) to compile the source code.
To build the project run the following command: 
 
  - npm run build
## Installing the module
You can install the module into your own node.js project as a dependency.
For testing purposes you can install using the following command:

  - npm install wmt-encryption-module
## Importing the module
Once you have the module installed you can import exported functions into your code like so:
```javascript
import * as encryption from 'wmt-encryption-module'
```
## Using the module
```javascript
// import the module
import * as encryption from 'wmt-encryption-module'

// create something
let somePlainText = "some plain text";

// set authentication key or password
encryption.setKey("1234");

// encrypt data
let encryptedText = encryption.encrypt(somePlainText); // encryptedText: "6dd34283b31adfa7fd5ec507d72e33b9"

// decrypt data
let decryptedText = encryption.decrypt(encryptedText); // decryptedText: "some plain text"
```

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