| Server IP : 127.0.0.2 / Your IP : 18.219.197.162 Web Server : Apache/2.4.18 (Ubuntu) System : User : www-data ( ) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : disk_free_space,disk_total_space,diskfreespace,dl,exec,fpaththru,getmyuid,getmypid,highlight_file,ignore_user_abord,leak,listen,link,opcache_get_configuration,opcache_get_status,passthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,php_uname,phpinfo,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwnam,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,pclose,popen,proc_open,proc_close,proc_get_status,proc_nice,proc_terminate,shell_exec,source,show_source,system,virtual MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/node-sha/ |
Upload File : |
# sha
Check and get file hashes (using any algorithm)
[](https://travis-ci.org/ForbesLindesay/sha)
[](https://gemnasium.com/ForbesLindesay/sha)
[](http://badge.fury.io/js/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.