130 lines
3.8 KiB
Markdown
130 lines
3.8 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<br>
|
|
<br>
|
|
<img width="380" src="media/logo.svg" alt="hasha">
|
|
<br>
|
|
<br>
|
|
<br>
|
|
<br>
|
|
<br>
|
|
</h1>
|
|
|
|
> Hashing made simple. Get the hash of a buffer/string/stream/file.
|
|
|
|
[](https://travis-ci.com/github/sindresorhus/hasha)
|
|
|
|
Convenience wrapper around the core [`crypto` Hash class](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm) with simpler API and better defaults.
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install hasha
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const hasha = require('hasha');
|
|
|
|
hasha('unicorn');
|
|
//=> 'e233b19aabc7d5e53826fb734d1222f1f0444c3a3fc67ff4af370a66e7cadd2cb24009f1bc86f0bed12ca5fcb226145ad10fc5f650f6ef0959f8aadc5a594b27'
|
|
```
|
|
|
|
```js
|
|
const hasha = require('hasha');
|
|
|
|
(async () => {
|
|
console.log(await hasha.async('unicorn'));
|
|
//=> 'e233b19aabc7d5e53826fb734d1222f1f0444c3a3fc67ff4af370a66e7cadd2cb24009f1bc86f0bed12ca5fcb226145ad10fc5f650f6ef0959f8aadc5a594b27'
|
|
})();
|
|
```
|
|
|
|
```js
|
|
const hasha = require('hasha');
|
|
|
|
// Hash the process input and output the hash sum
|
|
process.stdin.pipe(hasha.stream()).pipe(process.stdout);
|
|
```
|
|
|
|
```js
|
|
const hasha = require('hasha');
|
|
|
|
(async () => {
|
|
// Get the MD5 hash of an image
|
|
const hash = await hasha.fromFile('unicorn.png', {algorithm: 'md5'});
|
|
|
|
console.log(hash);
|
|
//=> '1abcb33beeb811dca15f0ac3e47b88d9'
|
|
})();
|
|
```
|
|
|
|
## API
|
|
|
|
See the Node.js [`crypto` docs](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options) for more about hashing.
|
|
|
|
### hasha(input, options?)
|
|
|
|
Returns a hash.
|
|
|
|
#### input
|
|
|
|
Type: `Buffer | string | Array<Buffer | string>`
|
|
|
|
Buffer you want 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.
|
|
|
|
#### options
|
|
|
|
Type: `object`
|
|
|
|
##### encoding
|
|
|
|
Type: `string`\
|
|
Default: `'hex'`\
|
|
Values: `'hex' | 'base64' | 'buffer' | 'latin1'`
|
|
|
|
Encoding of the returned hash.
|
|
|
|
##### algorithm
|
|
|
|
Type: `string`\
|
|
Default: `'sha512'`\
|
|
Values: `'md5' | 'sha1' | 'sha256' | 'sha512'` *([Platform dependent](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options))*
|
|
|
|
*The `md5` algorithm is good for [file revving](https://github.com/sindresorhus/rev-hash), but you should never use `md5` or `sha1` for anything sensitive. [They're insecure.](https://security.googleblog.com/2014/09/gradually-sunsetting-sha-1.html)*
|
|
|
|
### hasha.async(input, options?)
|
|
|
|
In Node.js 12 or later, 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.
|
|
|
|
### hasha.stream(options?)
|
|
|
|
Returns a [hash transform stream](https://nodejs.org/api/crypto.html#crypto_class_hash).
|
|
|
|
### hasha.fromStream(stream, options?)
|
|
|
|
Returns a `Promise` for the calculated hash.
|
|
|
|
### hasha.fromFile(filepath, options?)
|
|
|
|
In Node.js 12 or later, 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.
|
|
|
|
### hasha.fromFileSync(filepath, options?)
|
|
|
|
Returns the calculated file hash.
|
|
|
|
## Related
|
|
|
|
- [hasha-cli](https://github.com/sindresorhus/hasha-cli) - CLI for this module
|
|
- [crypto-hash](https://github.com/sindresorhus/crypto-hash) - Tiny hashing module that uses the native crypto API in Node.js and the browser
|
|
- [hash-obj](https://github.com/sindresorhus/hash-obj) - Get the hash of an object
|
|
- [md5-hex](https://github.com/sindresorhus/md5-hex) - Create a MD5 hash with hex encoding
|