object-hash
Generate hashes from objects and values in node and the browser. Uses node.js crypto module for hashing. Supports SHA1 and many others (depending on the platform) as well as custom streams (e.g. CRC32).
- Hash values of any type.
- Supports a keys only option for grouping similar objects with different values.
var hash = require('object-hash');
hash({foo: 'bar'}) // => '67b69634f9880a282c14a0f0cb7ba20cf5d677e9'
hash([1, 2, 2.718, 3.14159]) // => '136b9b88375971dff9f1af09d7356e3e04281951'
Versioning Disclaimer
Starting with version 1.1.8
(released April 2017), new versions will consider
the exact returned hash part of the API contract, i.e. changes that will affect
hash values will be considered semver-major
. Previous versions may violate
that expectation.
For more information, see this discussion.
hash(value, options);
Generate a hash from any object or type. Defaults to sha1 with hex encoding.
algorithm
hash algo to be used: 'sha1', 'md5'. default: sha1excludeValues
{true|false} hash object keys, values ignored. default: falseencoding
hash encoding, supports 'buffer', 'hex', 'binary', 'base64'. default: hexignoreUnknown
{true|*false} ignore unknown object types. default: falsereplacer
optional function that replaces values before hashing. default: accept all valuesrespectFunctionProperties
{true|false} Whether properties on functions are considered when hashing. default: truerespectFunctionNames
{true|false} considername
property of functions for hashing. default: truerespectType
{true|false} Whether special type attributes (.prototype
,.__proto__
,.constructor
) are hashed. default: trueunorderedArrays
{true|false} Sort all arrays using before hashing. Note that this affects all collections, i.e. including typed arrays, Sets, Maps, etc. default: falseunorderedSets
{true|false} SortSet
andMap
instances before hashing, i.e. makehash(new Set([1, 2])) == hash(new Set([2, 1]))
returntrue
. default: trueexcludeKeys
optional function for exclude specific key(s) from hashing, if returns false then exclude from hash. default: include all keys
hash.sha1(value);
Hash using the sha1 algorithm.
Sugar method, equivalent to hash(value, {algorithm: 'sha1'})
hash.keys(value);
Hash object keys using the sha1 algorithm, values ignored.
Sugar method, equivalent to hash(value, {excludeValues: true})
hash.MD5(value);
Hash using the md5 algorithm.
Sugar method, equivalent to hash(value, {algorithm: 'md5'})
hash.keysMD5(value);
Hash object keys using the md5 algorithm, values ignored.
Sugar method, equivalent to hash(value, {algorithm: 'md5', excludeValues: true})
hash.writeToStream(value, [options,] stream):
Write the information that would otherwise have been hashed to a stream, e.g.:
hash.writeToStream({foo: 'bar', a: 42}, {respectType: false}, process.stdout)
// => e.g. 'object:a:number:42foo:string:bar'
Installation
node:
npm install object-hash
browser: /dist/object_hash.js
<script src="object_hash.js" type="text/javascript"></script>
<script>
var hash = objectHash.sha1({foo:'bar'});
console.log(hash); // e003c89cdf35cdf46d8239b4692436364b7259f9
</script>
Example usage
var hash = require('object-hash');
var peter = {name: 'Peter', stapler: false, friends: ['Joanna', 'Michael', 'Samir'] };
var michael = {name: 'Michael', stapler: false, friends: ['Peter', 'Samir'] };
var bob = {name: 'Bob', stapler: true, friends: [] };
/***
* sha1 hex encoding (default)
*/
hash(peter);
// 14fa461bf4b98155e82adc86532938553b4d33a9
hash(michael);
// 4b2b30e27699979ce46714253bc2213010db039c
hash(bob);
// 38d96106bc8ef3d8bd369b99bb6972702c9826d5
/***
* hash object keys, values ignored
*/
hash(peter, { excludeValues: true });
// 48f370a772c7496f6c9d2e6d92e920c87dd00a5c
hash(michael, { excludeValues: true });
// 48f370a772c7496f6c9d2e6d92e920c87dd00a5c
hash.keys(bob);
// 48f370a772c7496f6c9d2e6d92e920c87dd00a5c
/***
* hash object, ignore specific keys
*/
hash(peter, { excludeKeys: function(key) {
if ( key === 'friends') {
return false;
}
return true;
}
});
// 66b7d7e64871aa9fda1bdc8e88a28df797648d80
/***
* md5 base64 encoding
*/
hash(peter, { algorithm: 'md5', encoding: 'base64' });
// 6rkWaaDiG3NynWw4svGH7g==
hash(michael, { algorithm: 'md5', encoding: 'base64' });
// djXaWpuWVJeOF8Sb6SFFNg==
hash(bob, { algorithm: 'md5', encoding: 'base64' });
// lFzkw/IJ8/12jZI0rQeS3w==
Legacy Browser Support
IE <= 8 and Opera <= 11 support dropped in version 0.3.0. If you require legacy browser support you must either use an ES5 shim or use version 0.2.5 of this module.
Development
git clone https://github.com/puleos/object-hash
gulp tasks
gulp watch
(default) watch files, test and lint on change/addgulp test
unit testsgulp karma
browser unit testsgulp lint
jshintgulp dist
create browser version in /dist
License
MIT