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.
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', 'passthrough'. default: sha1This supports the algorithms returned by
crypto.getHashes()
. Note that the default of SHA-1 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.This also supports the
passthrough
algorith, which will return the information that would otherwise have been hashed.excludeValues
{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: trueunorderedObjects
{true|false} Sort objects before hashing, i.e. makehash({ x: 1, y: 2 }) === hash({ y: 2, x: 1 })
. default: trueexcludeKeys
optional function for exclude specific key(s) from hashing, if returns true then exclude from hash. default: include all keys
hash.sha1(value);
Hash using the sha1 algorithm.
Note that SHA-1 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
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.
Note that the MD5 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
Sugar method, equivalent to hash(value, {algorithm: 'md5'})
hash.keysMD5(value);
Hash object keys using the md5 algorithm, values ignored.
Note that the MD5 is not considered secure, and a stronger algorithm should be used if a cryptographical hash is desired.
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.:
Installation
node:
browser: /dist/object_hash.js
Example usage
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
Node Docker Wrapper
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
Changelog
v2.0.0
Only Node.js versions >= 6.0.0
are being tested in CI now. No other breaking changes were introduced.
Last updated