diff options
author | isaacs <i@izs.me> | 2013-05-14 14:37:59 -0700 |
---|---|---|
committer | isaacs <i@izs.me> | 2013-05-14 14:37:59 -0700 |
commit | f7b10f5445248981a39f0f82e10fca7234fca08a (patch) | |
tree | 839a30d65dcdc93e3e7ddaebe2666eb1c27fb306 /deps/npm/node_modules/sha/README.md | |
parent | ca38def146c2255503103159677df40c169ccefa (diff) | |
download | node-f7b10f5445248981a39f0f82e10fca7234fca08a.tar.gz |
npm: Upgrade to 1.2.21
Diffstat (limited to 'deps/npm/node_modules/sha/README.md')
-rw-r--r-- | deps/npm/node_modules/sha/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/deps/npm/node_modules/sha/README.md b/deps/npm/node_modules/sha/README.md new file mode 100644 index 000000000..9ac740731 --- /dev/null +++ b/deps/npm/node_modules/sha/README.md @@ -0,0 +1,32 @@ +# sha + +Check and get file hashes (using any algorithm) + +[![Build Status](https://travis-ci.org/ForbesLindesay/sha.png?branch=master)](https://travis-ci.org/ForbesLindesay/sha) +[![Dependency Status](https://gemnasium.com/ForbesLindesay/sha.png)](https://gemnasium.com/ForbesLindesay/sha) + +## Installation + + $ npm install sha + +## API + +### check(fileName, expected, [options,] cb) + +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) + +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` + +## License + +BSD |