Repository URL to install this package:
|
Version:
1.16.0 ▾
|
{
"_from": "sha@>=2.0.1 <2.1.0",
"_id": "sha@2.0.1",
"_location": "/sha",
"_nodeVersion": "1.6.2",
"_npmUser": {
"name": "forbeslindesay",
"email": "forbes@lindesay.co.uk"
},
"_npmVersion": "2.7.1",
"_phantomChildren": {},
"_requiredBy": [
"/npm"
],
"_resolved": "https://registry.npmjs.org/sha/-/sha-2.0.1.tgz",
"_shasum": "6030822fbd2c9823949f8f72ed6411ee5cf25aae",
"_shrinkwrap": null,
"bugs": {
"url": "https://github.com/ForbesLindesay/sha/issues"
},
"dependencies": {
"graceful-fs": "^4.1.2",
"readable-stream": "^2.0.2"
},
"description": "Check and get file hashes",
"devDependencies": {
"mocha": "~1.9.0"
},
"directories": {},
"dist": {
"shasum": "6030822fbd2c9823949f8f72ed6411ee5cf25aae",
"tarball": "http://registry.npmjs.org/sha/-/sha-2.0.1.tgz"
},
"gitHead": "ce7c72ba753d886fb46c396cbadcbfc8eac25b4f",
"homepage": "https://github.com/ForbesLindesay/sha",
"license": "(BSD-2-Clause OR MIT)",
"maintainers": [
{
"name": "forbeslindesay",
"email": "forbes@lindesay.co.uk"
},
{
"name": "kenan",
"email": "kenan@kenany.me"
},
{
"name": "thefourtheye",
"email": "thechargingvolcano@gmail.com"
}
],
"name": "sha",
"optionalDependencies": {},
"readme": "# sha\n\nCheck and get file hashes (using any algorithm)\n\n[](https://travis-ci.org/ForbesLindesay/sha)\n[](https://gemnasium.com/ForbesLindesay/sha)\n[](http://badge.fury.io/js/sha)\n\n## Installation\n\n $ npm install sha\n\n## API\n\n### check(fileName, expected, [options,] cb) / checkSync(filename, expected, [options])\n\nAsynchronously 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).\n\nOptions:\n\n- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash`\n\n### get(fileName, [options,] cb) / getSync(filename, [options])\n\nAsynchronously get the \"hash\" of `fileName`. The callback will be called with an optional `error` object and the (lower cased) hex digest of the hash.\n\nOptions:\n\n- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash`\n\n### stream(expected, [options])\n\nCheck the hash of a stream without ever buffering it. This is a pass through stream so you can do things like:\n\n```js\nfs.createReadStream('src')\n .pipe(sha.stream('expected'))\n .pipe(fs.createWriteStream('dest'))\n```\n\n`dest` will be a complete copy of `src` and an error will be emitted if the hash did not match `'expected'`.\n\nOptions:\n\n- algorithm: defaults to `sha1` and can be any of the algorithms supported by `crypto.createHash`\n\n## License\n\nYou 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.",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/ForbesLindesay/sha.git"
},
"scripts": {
"test": "mocha -R spec"
},
"version": "2.0.1"
}