diff options
| author | Myles Borins <mylesborins@github.com> | 2020-10-02 17:52:19 -0400 |
|---|---|---|
| committer | Myles Borins <mylesborins@github.com> | 2020-10-07 09:59:49 -0400 |
| commit | 2e545249557c265f7d5f338cc3a382985211603c (patch) | |
| tree | a18ca49252a58cc5a80cd438a020a99bf48a8d23 /deps/npm/node_modules/sha/README.md | |
| parent | 14699846452e627f97dedb85991eea67d932a79d (diff) | |
| download | node-new-2e545249557c265f7d5f338cc3a382985211603c.tar.gz | |
deps: update npm to 7.0.0-rc.3
PR-URL: https://github.com/nodejs/node/pull/35474
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'deps/npm/node_modules/sha/README.md')
| -rw-r--r-- | deps/npm/node_modules/sha/README.md | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/deps/npm/node_modules/sha/README.md b/deps/npm/node_modules/sha/README.md deleted file mode 100644 index 43742bf479..0000000000 --- a/deps/npm/node_modules/sha/README.md +++ /dev/null @@ -1,49 +0,0 @@ -# sha - -Check and get file hashes (using any algorithm) - -[](https://travis-ci.org/ForbesLindesay/sha) -[](https://david-dm.org/ForbesLindesay/sha) -[](https://www.npmjs.com/package/sha) - -## Installation - - $ npm install sha - -## API - -### check(fileName, expected, [options,] cb) / checkSync(filename, expected, [options]) - -Asynchronously check that `fileName` has a "hash" of `expected`. The callback will be called with either `null` or an error (indicating that they did not match). - -Options: - -- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash` - -### get(fileName, [options,] cb) / getSync(filename, [options]) - -Asynchronously get the "hash" of `fileName`. The callback will be called with an optional `error` object and the (lower cased) hex digest of the hash. - -Options: - -- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash` - -### stream(expected, [options]) - -Check the hash of a stream without ever buffering it. This is a pass through stream so you can do things like: - -```js -fs.createReadStream('src') - .pipe(sha.stream('expected')) - .pipe(fs.createWriteStream('dest')) -``` - -`dest` will be a complete copy of `src` and an error will be emitted if the hash did not match `'expected'`. - -Options: - -- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash` - -## License - -You may use this software under the BSD or MIT. Take your pick. If you want me to release it under another license, open a pull request.
\ No newline at end of file |