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.
addaleax
anna@addaleax.net
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.
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.
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 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 excluding specific key(s) from hashing, if true is returned 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.
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
Node Docker Wrapper
If you want to stand this up in a docker container, you should take at look
at the project.
gulp tasks
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
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.