Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 1.33 KB

README.md

File metadata and controls

71 lines (46 loc) · 1.33 KB

scryptwrap

Build Status

A wrapper for the crypto.scrypt(), that can be used as a replacement for argon2 or bcrypt

It does not have any additional dependencies

Minimal required Node version is 10.5.0

Installation

npm i scryptwrap

Usage

Load the module:

import { compare, hash } from 'scryptwrap';

Create a hash:

const hashed = await hash('plaintext');

Compare hash with a plaintext string:

const isValid = await compare(hashed, 'plaintext');
if (isValid) {
  // plaintext string is valid
}

Testing

Deploy the project locally:

git clone https://github.com/julyskies/scryptwrap
cd ./scryptwrap
nvm use 16
npm i

Run tests:

npm run test

Tests are done with Jest

Linting

After deploying the project and installing the modules you can do the linting:

npm run lint

Using ESLint

License

MIT