Provides simplified access to Node.js hash functions, including SHA256 and MD5, with support for strings, streams, and files.
Go to file
2019-12-15 22:49:22 +00:00
test fix(ci): update 2019-11-21 14:20:57 +00:00
ts fix(ci): update 2019-11-21 14:20:57 +00:00
.gitignore fix(core): update 2019-07-04 16:56:37 +02:00
.gitlab-ci.yml fix(core): update 2019-12-15 19:22:27 +00:00
.snyk fix(snyk): add .snyk file and mark as Open Source 2019-01-30 02:45:38 +01:00
LICENSE fix(core): update 2019-01-30 02:43:08 +01:00
npmextra.json fix(core): update 2019-12-15 22:49:22 +00:00
package-lock.json fix(core): update 2019-12-15 22:49:22 +00:00
package.json fix(core): update 2019-12-15 22:49:22 +00:00
readme.md fix(core): update 2019-12-15 19:12:01 +00:00
tslint.json fix(core): update 2019-01-30 02:37:55 +01:00

@pushrocks/smarthash

simplifies access to node hash functions

Status for master

build status coverage report npm downloads per month Known Vulnerabilities TypeScript node JavaScript Style Guide

Usage

We recommend the use of TypeScript for best in class intellisense.

import * as smarthash from "smarthash";

// ======
// sha265
// ======

// from stream
let readStream = fs.createReadStream("./somefile.txt")
smarthash.sha256FromStream(readStream)
    .then((resultString){
        console.log(resultString); // prints hash of the file
    });

// from file
smarthash.sha256FromFile("./somefile.txt")
    .then((resultString){
        console.log(resultString); // prints hash of the file
    });

// from string
smarthash.sha256FromString("some weird random string")
    .then((resultString){
        console.log(resultString); // prints hash of the file
    });

let hashString = smarthash.sha256FromStringSync("some weird random string");

// ===
// md5
// ===
smarthash.md5FromString('hellothere').then(md5String = {
    // do something with it here
})

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer