/hash-stream

Get a hash of a file or a stream

Primary LanguageJavaScriptMIT LicenseMIT

Hash Stream

NPM version Build status Test coverage Dependency Status License Downloads

Simple wrapper around crypto.createHash() for files and streams.

Installation

$ npm install hash-stream

API

var getHash = require('hash-stream')

getHash(filename || stream, algorithm, callback)

  • filename - path of the file
  • stream - a readable stream
  • algorithm - any defined by crypto.getHashes()

Returns a hash as a raw Buffer, so if you want a hex:

getHash('image.png', 'sha256', function (err, hash) {
  hash = hash.toString('hex')
})

You can use nhash to hash a file and get the output instantly. The usage options are simple:

$ nhash --help
Usage: nhash [options] [file]

Options:

  -h, --help              output usage information
  -V, --version           output the version number
  -a, --algorithm <sha1>  the hash alorithm
  -e, --encoding <hex>    the encoding of output