Skip to content

maraisr/object-identity

Repository files navigation

object-identity licenses

A utility that provides a stable identity of an object

This is free to use software, but if you do like it, consider supporting me ❤️

sponsor me buy me a coffee

⚡ Features

  • Intuitive
  • 🌪 Recursive/Circular support
  • 🏎 Performant — check the benchmarks.
  • 🪶 Lightweight — a mere 387B and no dependencies.

🚀 Usage

Avaliable on jsr, NPM and deno.land

import { identify } from 'object-identity';
// or
import { identify } from 'https://deno.land/x/object_identity';

// ~> identity the object
const id1 = identify({ a: new Set(['b', 'c', new Map([['d', 'e']])]) });
// ~> an entirely different object, but structurally the same
const id2 = identify({ a: new Set(['b', 'c', new Map([['e', 'e']])]) });

// they should equal
assert.toEqual(hashA, hashB);

💨 Benchmark

via the /bench directory with deno 1.41.3

✔ object-identity       ~ 14,646,170 ops/sec ± 0.10%
✔ object-hash           ~    144,060 ops/sec ± 0.01%
✔ json-stable-stringify ~    638,559 ops/sec ± 0.01%

^ object-identity is not as feature-full it's alternatives, specifically around function values and other node builtins. So take this benchmark with a grain of salt, as it's only testing "json-like" payloads.

License

MIT © Marais Rossouw

About

#️⃣ Object hashing for structural equality

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project