planttheideahash-it
Fast and consistent hashCode for any object type
Table of contents
Usage
// ES2015
import hash from 'hash-it';
// CommonJS
const hash = require('hash-it');
// hash any standard object
console.log(hash({ foo: 'bar' })); // 13729774857125
// or a circular object
console.log(hash(window)); // 3270731309314
Overview
hash-it has a simple goal: provide a fast, consistent, unique hashCode for any object type that is uniquely based on its values. This has a number of uses such as duplication prevention, equality comparisons, blockchain construction, etc.
Any object type?
Yes, any object type. Primitives, ES2015 classes like Symbol, DOM elements (yes, you can even hash the window object if you want). Any object type. Here is the list of object classes that produce consistent, unique hashes based on their value:
ArgumentsArrayArrayBufferAsyncFunction(based ontoString)AsyncGeneratorFunction(based ontoString)BigIntBigInt64ArrayBigUint64ArrayBooleanDataView(based on itsbuffer)Date(based ongetTime)DocumentFragment(based onouterHTMLof allchildren)Error(based onstack)- Includes all sub-types (e.g.,
TypeError,ReferenceError, etc.)
- Includes all sub-types (e.g.,
Event(based on all properties other thanEvent.timeStamp)- Includes all sub-types (e.g.,
MouseEvent,KeyboardEvent, etc.)
- Includes all sub-types (e.g.,
Float32ArrayFloat64ArrayFunction(based ontoString)GeneratorFunction(based ontoString)Int8ArrayInt16ArrayInt32ArrayHTMLElement(based onouterHTML)- Includes all sub-types (e.g.,
HTMLAnchorElement,HTMLDivElement, etc.)
- Includes all sub-types (e.g.,
Map(order-agnostic)NullNumberObject(handles circular objects, order-agnostic)ProxyRegExpSet(order-agnostic)SharedArrayBufferStringSVGElement(based onouterHTML)- Includes all sub-types (e.g.,
SVGRectElement,SVGPolygonElement, etc.)
- Includes all sub-types (e.g.,
Symbol(based ontoString)Uint8ArrayUint8ClampedArrayUint16ArrayUint32ArrayUndefinedWindow
Are there any exceptions?
Sadly, yes, there are a few scenarios where internal values cannot be introspected for the object. In this case, the object is hashed based on its class type and reference.
Promise- There is no way to obtain the values contained within due to its asynchronous nature
Generator(the result of calling aGeneratorFunction)- Like
Promise, there is no way to obtain the values contained within due to its dynamic iterable nature
- Like
WeakMap/WeakRef/WeakSet- The spec explicitly forbids iteration over them, so the unique values cannot be discovered
const promise = Promise.resolve(123);
console.log(hash(promise)); // 16843037491939
console.log(hash(promise)); // 16843037491939
console.log(hash(Promise.resolve(123))); // 4622327363876
If there is an object class or data type that is missing, please submit an issue.
Hash consistency
While the hashes will be consistent when calculated within the same environment, there is no guarantee that the resulting hash will be the same across different environments due to environment-specific or browser-specific implementations of features. This is limited to extreme edge cases, such as hashing the window object, but should be considered if being used with persistence over different environments.
Support
Browsers
- Chrome (all versions)
- Firefox (all versions)
- Edge (all versions)
- Opera 15+
- IE 9+
- Safari 6+
- iOS 8+
- Android 4+
Node
- 4+
Development
Clone the repo and dependencies via yarn. The npm scripts available:
benchmark=> run benchmark of various data typesbenchmark:compare=> run benchmark of some data types comparing against other hashing modulesbuild=> run rollup to build ESM, CJS, and UMD filesclean=> remove files produced frombuildscriptdev=> run webpack dev server to run example app / playgroundlint=> run ESLint against all files in thesrcfolderlint:fix=> runlintscript, automatically applying fixable changesprepublishOnly=> runtypecheck,lint,test, andbuildstart=> alias fordevscripttest=> run jest test functions withNODE_ENV=testtest:coverage=> runtestwith coverage checkertest:watch=> runtestwith persistent watchertypecheck=> runtscto validate internal typings