object-hash
Last updated
Last updated
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.
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.
Generate a hash from any object or type. Defaults to sha1 with hex encoding.
algorithm
hash algo to be used: 'sha1', 'md5', 'passthrough'. default: sha1
This 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: false
encoding
hash encoding, supports 'buffer', 'hex', 'binary', 'base64'. default: hex
ignoreUnknown
{true|*false} ignore unknown object types. default: false
replacer
optional function that replaces values before hashing. default: accept all values
respectFunctionProperties
{true|false} Whether properties on functions are considered when hashing. default: true
respectFunctionNames
{true|false} consider name
property of functions for hashing. default: true
respectType
{true|false} Whether special type attributes (.prototype
, .__proto__
, .constructor
) are hashed. default: true
unorderedArrays
{true|false} Sort all arrays using before hashing. Note that this affects all collections, i.e. including typed arrays, Sets, Maps, etc. default: false
unorderedSets
{true|false} Sort Set
and Map
instances before hashing, i.e. make hash(new Set([1, 2])) == hash(new Set([2, 1]))
return true
. default: true
unorderedObjects
{true|false} Sort objects before hashing, i.e. make hash({ x: 1, y: 2 }) === hash({ y: 2, x: 1 })
. default: true
excludeKeys
optional function for exclude specific key(s) from hashing, if returns true then exclude from hash. default: include all keys
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 object keys using the sha1 algorithm, values ignored.
Sugar method, equivalent to hash(value, {excludeValues: true})
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 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})
Write the information that would otherwise have been hashed to a stream, e.g.:
node:
browser: /dist/object_hash.js
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.
gulp watch
(default) watch files, test and lint on change/add
gulp test
unit tests
gulp karma
browser unit tests
gulp lint
jshint
gulp dist
create browser version in /dist
MIT
Only Node.js versions >= 6.0.0
are being tested in CI now. No other breaking changes were introduced.