Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including collections-deep-equal with all npm packages installed. Try it out:

var collectionsDeepEqual = require("collections-deep-equal")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

collections-deep-equal v2.0.0

Collections like JavaScript’s native Maps and Sets, but using value equality (util.isDeepStrictEqual()) instead of reference equality

Collections Deep Equal

Collections like JavaScript’s native Maps and Sets, but using value equality (util.isDeepStrictEqual()) instead of reference equality

Source Package Continuous Integration

Problem

Native JavaScript Maps and Sets use a notion of equality in which an object is considered equal to itself but not to another object with the same keys and values:

const object = { name: "Leandro", age: 29 };
const deepEqualObject = { name: "Leandro", age: 29 };
assert(object === object);
assert(object !== deepEqualObject);
assert.deepEqual(object, deepEqualObject);

const map = new Map();
map.set(object, "value");
assert(map.get(object) === "value");
assert(map.get(deepEqualObject) === undefined);

const set = new Set();
set.add(object);
assert(set.has(object));
assert(!set.has(deepEqualObject));

One the one hand, this is good, because object and deepEqualObject are not the same object. We may, for example, modify object such that deepEqualObject would no longer be deep equal to it:

object.age = 30;
assert.notDeepEqual(object, deepEqualObject);
assert(object.age === 30);
assert(deepEqualObject.age === 29);

On the other hand, this is annoying, because you may know that you’re never mutating objects like that, and yet JavaScript doesn’t give you a way to customize the notion of equality used by Maps and Sets.

Solution

Collections Deep Equal provides Maps and Sets which have the same API as native Maps and Sets, except that their notion of equality is util.isDeepStrictEqual():

import { Map, Set } from "collections-deep-equal";

const object = { name: "Leandro", age: 29 };
const deepEqualObject = { name: "Leandro", age: 29 };

const map = new Map();
assert(map.get(deepEqualObject) === "value");

const set = new Set();
assert(set.has(deepEqualObject));

Installation

Install with npm:

$ npm install collections-deep-equal

The package comes with type definitions for TypeScript.

If you wish to use only Collections Deep Equal and not native Maps and Sets, import the library:

import { Map, Set } from "collections-deep-equal";

If you wish to use both Collections Deep Equal as well as native Maps and Sets in the same module, rename on import:

import {
  Map as MapDeepEqual,
  Set as SetDeepEqual,
} from "collections-deep-equal";

Caveats

Performance

Collections Deep Equal hasn’t been benchmarked, but it should be orders of magnitude slower than the native collections, because for every access it iterates over all keys and calls deepEqual() on them. It’s a straightforward, if naive, implementation.

Mutation

If you mutate objects, then the collections using them change as well:

const object = { name: "Leandro", age: 29 };
const deepEqualObject = { name: "Leandro", age: 29 };

const map = new Map();
map.set(object, "value");
object.age = 30;
assert(!map.has(deepEqualObject));
deepEqualObject.age = 30;
assert(map.has(deepEqualObject));

Additional Features

merge()

assert.deepEqual(
  new Map([
    ["a", new Set([1])],
    ["b", new Set([2])],
  ]).merge(
    new Map([
      ["b", new Set([3])],
      ["c", new Set([4])],
    ])
  ),
  new Map([
    ["a", new Set([1])],
    ["b", new Set([2, 3])],
    ["c", new Set([4])],
  ])
);

assert.deepEqual(new Set([1]).merge(new Set([2])), new Set([1, 2]));

toJSON()

assert(JSON.stringify(new Map([["a", 1]])) === `[["a",1]]`);
assert(JSON.stringify(new Set([1, 2])) === `[1,2]`);

Related Work

People Discussing the Issue

  • https://2ality.com/2015/01/es6-maps-sets.html#why-can’t-i-configure-how-maps-and-sets-compare-keys-and-values%3F
  • https://stackoverflow.com/questions/21838436/map-using-tuples-or-objects
  • https://esdiscuss.org/topic/maps-with-object-keys
  • https://medium.com/@modernserf/the-tyranny-of-triple-equals-de46cc0c5723

Other Libraries That Implementation Alternative Collections

  • https://immutable-js.github.io/immutable-js/
  • http://swannodette.github.io/mori/
  • https://www.npmjs.com/package/typescript-collections
  • https://www.npmjs.com/package/prelude-ts
  • https://www.npmjs.com/package/collectable
  • https://www.collectionsjs.com

The advantages of Collections Deep Equal over these libraries are:

  1. You don’t have to buy into completely new data structures like Immutable.js’s Records. These other data structures may have different APIs and therefore have a bit of a learning curve; they may be more difficult to inspect in debuggers; they may not work well with other libraries, forcing you to convert back and forth; and they may annoying to use in TypeScript.

  2. The notion of equality is determined by the data structures, not by the elements. In most of these libraries, elements are forced to implement equals() and hash(), which makes sense in a object-oriented style, but not in a functional style.

  3. Immutability is possible and encouraged, but not enforced. For better and for worse.

  4. Collections Deep Equal is so simple that you could maintain it yourself if it’s abandoned, like some of the packages above seem to have been. But don’t worry, Collections Deep Equal is being used in my dissertation, so it’ll stick around.

Other Approaches to Immutability

  • https://immerjs.github.io/immer/docs/introduction
  • https://www.npmjs.com/package/seamless-immutable
  • https://www.npmjs.com/package/icepick
  • https://www.npmjs.com/package/deep-freeze

These libraries don’t provide new data structures. They’re just facilitating the use of immutable data structures, which may pave the way to a new notion of equality.

Very Similar But Incomplete Approaches

  • https://www.npmjs.com/package/es6-array-map
  • https://www.npmjs.com/package/valuecollection
  • https://www.npmjs.com/package/@strong-roots-capital/map-objects

These libraries are very similar to Collections Deep Equal in spirit, but their implementations are either incomplete, or they lack type definitions, and so forth.

Definitive Solutions

  • https://github.com/tc39/proposal-record-tuple
  • https://github.com/sebmarkbage/ecmascript-immutable-data-structures
  • https://github.com/DavidBruant/Map-Set.prototype.toJSON

Proposals to change the JavaScript language in ways that would make this package obsolete.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free