54 lines
2.3 KiB
Markdown
54 lines
2.3 KiB
Markdown
# @pushrocks/smarthash
|
|
simplified access to node hash functions
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarthash)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smarthash)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smarthash)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smarthash/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smarthash/commits/master)
|
|
[](https://gitlab.com/pushrocks/smarthash/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smarthash)
|
|
[](https://snyk.io/test/npm/@pushrocks/smarthash)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
We recommend the use of TypeScript for best in class intellisense.
|
|
|
|
```typescript
|
|
import * as nodehash from "nodehash";
|
|
|
|
// from stream
|
|
let readStream = fs.createReadStream("./somefile.txt")
|
|
nodehash.sha256FromStream(readStream)
|
|
.then((resultString){
|
|
console.log(resultString); // prints hash of the file
|
|
});
|
|
|
|
// from file
|
|
nodehash.sha256FromFile("./somefile.txt")
|
|
.then((resultString){
|
|
console.log(resultString); // prints hash of the file
|
|
});
|
|
|
|
// from string
|
|
nodehash.sha256FromString("some weird random string")
|
|
.then((resultString){
|
|
console.log(resultString); // prints hash of the file
|
|
});
|
|
|
|
let hashString = nodehash.sha256FromStringSync("some weird random string");
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://maintainedby.lossless.com)
|