Hashing made simple. Get the hash of a buffer/string/stream/file.
Convenience wrapper around the core crypto Hash class with simpler API and better defaults.
Install
npm install hasha
Usage
import {hash} from 'hasha';await hash('unicorn');//=> 'e233b19aabc7d5e53826fb734d1222f1f0444c3a3fc67ff4af370a66e7cadd2cb24009f1bc86f0bed12ca5fcb226145ad10fc5f650f6ef0959f8aadc5a594b27'
API
See the Node.js crypto docs for more about hashing.
hash(input, options?)
The operation is executed using worker_threads. A thread is lazily spawned on the first operation and lives until the end of the program execution. It's unrefed, so it won't keep the process alive.
Returns a hash asynchronously.
hashSync(input, options?)
Returns a hash.
input
Type: Uint8Array | string | Array<Uint8Array | string> | NodeJS.ReadableStream(NodeJS.ReadableStream is not available in hashSync)
The value to hash.
While strings are supported you should prefer buffers as they're faster to hash. Although if you already have a string you should not convert it to a buffer.
Pass an array instead of concatenating strings and/or buffers. The output is the same, but arrays do not incur the overhead of concatenation.
The operation is executed using worker_threads. A thread is lazily spawned on the first operation and lives until the end of the program execution. It's unrefed, so it won't keep the process alive.
Returns a Promise for the calculated file hash.
import {hashFile} from 'hasha';// Get the MD5 hash of an imageawait hashFile('unicorn.png', {algorithm: 'md5'});//=> '1abcb33beeb811dca15f0ac3e47b88d9'
hashFileSync(filePath, options?)
Returns the calculated file hash.
import {hashFileSync} from 'hasha';// Get the MD5 hash of an imagehashFileSync('unicorn.png', {algorithm: 'md5'});//=> '1abcb33beeb811dca15f0ac3e47b88d9'