object-code
v1.3.3
Published
A blazing fast hash code generator that supports every possible javascript value.
Downloads
493,515
Readme
Table of Contents
Installing
Node
npm install object-code # or yarn add object-code
const { hash } = require('object-code');
import { hash } from 'object-code';
Browser
<script
crossorigin
src="https://cdn.jsdelivr.net/npm/object-code@latest/dist/index.umd.js"
></script>
const { hash } = window.objectCode;
Url Import
import { hash } from 'https://cdn.skypack.dev/object-code@latest';
Getting Started
Object code is a blazing fast hash code generator. It generates unique signed integers for objects, arrays, functions, symbols and etc.
You can ise it to index object in a collection, compare objects or just generate unique identifiers.
import { hash } from 'object-code';
const myWeirdObject = {
name: 'Arthur',
age: 20,
address: {
private: true
},
sayHello: function () {
console.log('Hello!');
},
id: Symbol('arthur'),
birth: new Date(2005, 02, 27),
tags: ['person', 'male', 'programmer']
recursive: myWeirdObject,
// etc
};
const hash = hash(myWeirdObject);
// -1352827948
Compatibility
See all unique values at test/values.ts
This package is always seeking for a faster implementation. This means that we don't guarantee that the hash will be the same for two different versions of this package. There will be an warning on the release notes if the hash generation changed.
You shouldn't rely on cross version compatibility, and even if so, you can run some tests before pushing to production :)
Benchmark
This is the result of a benchmark between object-hash
and
object-code
:
Object Code:
492 919 ops/s, ±0.90% | 84.72% slower
Object Hash:
48 311 ops/s, ±0.89% | slowest, 98.5% slower
Object Code (Jsonified Object):
401 901 ops/s, ±0.75% | 87.54% slower
Object Hash (Jsonified Object):
213 819 ops/s, ±0.48% | 93.37% slower
Object Code (String):
3 225 590 ops/s, ±1.94% | fastest
Object Hash (String):
424 569 ops/s, ±2.88% | 86.84% slower
License
Licensed under the MIT. See LICENSE
for more informations.