Provides simplified access to Node.js hash functions, including SHA256 and MD5, with support for strings, streams, and files.
Go to file
2022-06-26 11:34:09 +02:00
.vscode BREAKING CHANGE(core): switch to esm 2022-06-26 11:34:09 +02:00
test BREAKING CHANGE(core): switch to esm 2022-06-26 11:34:09 +02:00
ts BREAKING CHANGE(core): switch to esm 2022-06-26 11:34:09 +02:00
.gitignore fix(core): update 2020-10-05 15:07:28 +00:00
.gitlab-ci.yml BREAKING CHANGE(core): switch to esm 2022-06-26 11:34:09 +02:00
npmextra.json BREAKING CHANGE(core): switch to esm 2022-06-26 11:34:09 +02:00
package-lock.json 3.0.0 2022-06-26 11:34:09 +02:00
package.json 3.0.0 2022-06-26 11:34:09 +02:00
readme.md fix(core): update 2020-10-05 15:07:28 +00:00

@pushrocks/smarthash

simplifies access to node hash functions

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

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