object-hash
Advanced tools
Package description
The object-hash npm package provides a function to generate a hash from a JavaScript object using various algorithms. It is useful for creating unique identifiers for objects, comparing objects by their hash, and caching objects based on their content.
Generate hash from an object
This feature allows you to generate a hash string from a JavaScript object. The hash is determined by the object's content.
const hash = require('object-hash');
const myObject = { name: 'Alice', age: 25 };
const objectHash = hash(myObject);Generate hash with different algorithms
This feature allows you to specify different hashing algorithms, such as 'md5', 'sha1', 'sha256', etc., to generate the hash.
const hash = require('object-hash');
const options = { algorithm: 'sha256' };
const objectHash = hash({ name: 'Alice', age: 25 }, options);Exclude properties from hashing
This feature allows you to exclude the values of the properties from the hash, effectively hashing the structure (keys) of the object only.
const hash = require('object-hash');
const options = { excludeValues: true };
const objectHash = hash({ name: 'Alice', age: 25 }, options);Respect object types
This feature allows you to ignore the type of the object when generating the hash, treating arrays and objects with the same content as equal.
const hash = require('object-hash');
const options = { respectType: false };
const objectHash = hash([1, 2, 3], options);hash-object is an npm package that also generates hashes from JavaScript objects. It is similar to object-hash but may have different options and hashing capabilities.
json-hash is another npm package that hashes JSON objects. It differs from object-hash in the way it processes and generates the hash, potentially leading to different hash values for the same object.
deep-hash provides functionality to hash nested objects. While similar to object-hash, it may have different features or performance characteristics when dealing with deeply nested structures.
Readme
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).
var hash = require('object-hash');
hash({foo: 'bar'}) // => '67b69634f9880a282c14a0f0cb7ba20cf5d677e9'
hash([1, 2, 2.718, 3.14159]) // => '136b9b88375971dff9f1af09d7356e3e04281951'
IMPORTANT: If you need lasting hash consistency, you should should lock object-hash at a specific version, because new versions (even patch versions) are likely to affect the result. For more info, 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'. 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} consider name 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} Sort Set and Map instances before hashing, i.e. make
hash(new Set([1, 2])) == hash(new Set([2, 1])) return true. default: trueHash using the sha1 algorithm.
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.
Sugar method, equivalent to hash(value, {algorithm: 'md5'})
Hash object keys using the md5 algorithm, values ignored.
Sugar method, equivalent to hash(value, {algorithm: 'md5', excludeValues: true})
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'
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>
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
/***
* 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==
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.
git clone https://github.com/puleos/object-hash
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 /distMIT
FAQs
Generate hashes from javascript objects in node and the browser.
We found that object-hash demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.