1. module hasha
   1. function hasha (input, opts)
   2. function hasha.fromFile (fp, opts)
   3. function hasha.fromFileSync (fp, opts)
   4. function hasha.fromStream (stream, opts)
   5. function hasha.index (input, opts)
   6. function hasha.stream (opts)
2. module hasha.index
   1. function hasha.index (input, opts)
   2. function hasha.index.fromFile (fp, opts)
   3. function hasha.index.fromFileSync (fp, opts)
   4. function hasha.index.fromStream (stream, opts)
   5. function hasha.index.stream (opts)

module hasha

function hasha (input, opts)

• description and source-code

  hasha = function (input, opts) {
  	opts = opts || {};
  
  	var outputEncoding = opts.encoding || 'hex';
  
  	if (outputEncoding === 'buffer') {
  		outputEncoding = undefined;
  	}
  
  	var hash = crypto.createHash(opts.algorithm || 'sha512');
  
  	var update = function (buf) {
  		var inputEncoding = typeof buf === 'string' ? 'utf8' : undefined;
  		hash.update(buf, inputEncoding);
  	};
  
  	if (Array.isArray(input)) {
  		input.forEach(update);
  	} else {
  		update(input);
  	}
  
  	return hash.digest(outputEncoding);
  }

• example usage

  n/a

function hasha.fromFile (fp, opts)

• description and source-code

  fromFile = function (fp, opts) {
  	return hasha.fromStream(fs.createReadStream(fp), opts);
  }

• example usage

  ...
  process.stdin.pipe(hasha.stream()).pipe(process.stdout);
  ```
  
  ```js
  var hasha = require('hasha');
  
  // get the MD5 hash of an image
  hasha.fromFile('unicorn.png', {algorithm: 'md5'}).then(function (
  hash) {
  	console.log(hash);
  	//=> '1abcb33beeb811dca15f0ac3e47b88d9'
  });
  ```
  
  
  ## API
  ...

function hasha.fromFileSync (fp, opts)

• description and source-code

  fromFileSync = function (fp, opts) {
  	return hasha(fs.readFileSync(fp), opts);
  }

• example usage

  ...
  
  Returns a promise that resolves to a hash.
  
  ### hasha.fromFile(filepath, [options])
  
  Returns a promise that resolves to a hash.
  
  ### hasha.fromFileSync(filepath, [options])
  
  Returns a hash.
  
  
  ## Resources
  
  - [Hasha: A Friendly Crypto API • DailyJS](http://dailyjs.com/2015/06/12/hasha-a-friendly-crypto-api/)
  ...

function hasha.fromStream (stream, opts)

• description and source-code

  fromStream = function (stream, opts) {
  	if (!isStream(stream)) {
  		return Promise.reject(new TypeError('Expected a stream'));
  	}
  
  	opts = opts || {};
  
  	return new Promise(function (resolve, reject) {
  		stream
  			.on('error', reject)
  			.pipe(hasha.stream(opts))
  			.on('error', reject)
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  }

• example usage

  ...
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  };
  
  hasha.fromFile = function (fp, opts) {
  	return hasha.fromStream(fs.createReadStream(fp), opts);
  };
  
  hasha.fromFileSync = function (fp, opts) {
  	return hasha(fs.readFileSync(fp), opts);
  };
  ...

function hasha.index (input, opts)

• description and source-code

  index = function (input, opts) {
  	opts = opts || {};
  
  	var outputEncoding = opts.encoding || 'hex';
  
  	if (outputEncoding === 'buffer') {
  		outputEncoding = undefined;
  	}
  
  	var hash = crypto.createHash(opts.algorithm || 'sha512');
  
  	var update = function (buf) {
  		var inputEncoding = typeof buf === 'string' ? 'utf8' : undefined;
  		hash.update(buf, inputEncoding);
  	};
  
  	if (Array.isArray(input)) {
  		input.forEach(update);
  	} else {
  		update(input);
  	}
  
  	return hash.digest(outputEncoding);
  }

• example usage

  n/a

function hasha.stream (opts)

• description and source-code

  stream = function (opts) {
  	opts = opts || {};
  
  	var outputEncoding = opts.encoding || 'hex';
  
  	if (outputEncoding === 'buffer') {
  		outputEncoding = undefined;
  	}
  
  	var stream = crypto.createHash(opts.algorithm || 'sha512');
  	stream.setEncoding(outputEncoding);
  	return stream;
  }

• example usage

  ...
  	}
  
  	opts = opts || {};
  
  	return new Promise(function (resolve, reject) {
  		stream
  			.on('error', reject)
  			.pipe(hasha.stream(opts))
  			.on('error', reject)
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  };
  ...

module hasha.index

function hasha.index (input, opts)

• description and source-code

  index = function (input, opts) {
  	opts = opts || {};
  
  	var outputEncoding = opts.encoding || 'hex';
  
  	if (outputEncoding === 'buffer') {
  		outputEncoding = undefined;
  	}
  
  	var hash = crypto.createHash(opts.algorithm || 'sha512');
  
  	var update = function (buf) {
  		var inputEncoding = typeof buf === 'string' ? 'utf8' : undefined;
  		hash.update(buf, inputEncoding);
  	};
  
  	if (Array.isArray(input)) {
  		input.forEach(update);
  	} else {
  		update(input);
  	}
  
  	return hash.digest(outputEncoding);
  }

• example usage

  n/a

function hasha.index.fromFile (fp, opts)

• description and source-code

  fromFile = function (fp, opts) {
  	return hasha.fromStream(fs.createReadStream(fp), opts);
  }

• example usage

  ...
  process.stdin.pipe(hasha.stream()).pipe(process.stdout);
  ```
  
  ```js
  var hasha = require('hasha');
  
  // get the MD5 hash of an image
  hasha.fromFile('unicorn.png', {algorithm: 'md5'}).then(function (
  hash) {
  	console.log(hash);
  	//=> '1abcb33beeb811dca15f0ac3e47b88d9'
  });
  ```
  
  
  ## API
  ...

function hasha.index.fromFileSync (fp, opts)

• description and source-code

  fromFileSync = function (fp, opts) {
  	return hasha(fs.readFileSync(fp), opts);
  }

• example usage

  ...
  
  Returns a promise that resolves to a hash.
  
  ### hasha.fromFile(filepath, [options])
  
  Returns a promise that resolves to a hash.
  
  ### hasha.fromFileSync(filepath, [options])
  
  Returns a hash.
  
  
  ## Resources
  
  - [Hasha: A Friendly Crypto API • DailyJS](http://dailyjs.com/2015/06/12/hasha-a-friendly-crypto-api/)
  ...

function hasha.index.fromStream (stream, opts)

• description and source-code

  fromStream = function (stream, opts) {
  	if (!isStream(stream)) {
  		return Promise.reject(new TypeError('Expected a stream'));
  	}
  
  	opts = opts || {};
  
  	return new Promise(function (resolve, reject) {
  		stream
  			.on('error', reject)
  			.pipe(hasha.stream(opts))
  			.on('error', reject)
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  }

• example usage

  ...
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  };
  
  hasha.fromFile = function (fp, opts) {
  	return hasha.fromStream(fs.createReadStream(fp), opts);
  };
  
  hasha.fromFileSync = function (fp, opts) {
  	return hasha(fs.readFileSync(fp), opts);
  };
  ...

function hasha.index.stream (opts)

• description and source-code

  stream = function (opts) {
  	opts = opts || {};
  
  	var outputEncoding = opts.encoding || 'hex';
  
  	if (outputEncoding === 'buffer') {
  		outputEncoding = undefined;
  	}
  
  	var stream = crypto.createHash(opts.algorithm || 'sha512');
  	stream.setEncoding(outputEncoding);
  	return stream;
  }

• example usage

  ...
  	}
  
  	opts = opts || {};
  
  	return new Promise(function (resolve, reject) {
  		stream
  			.on('error', reject)
  			.pipe(hasha.stream(opts))
  			.on('error', reject)
  			.on('finish', function () {
  				resolve(this.read());
  			});
  	});
  };
  ...