Get unlimited public & private packages + team-based management with npm Teams.Learn more »

@thi.ng/equiv

1.0.12 • Public • Published

@thi.ng/equiv

npm version npm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Extensible deep value equivalence checking for any data types.

Supports:

  • JS primitives
  • Arrays
  • Plain objects
  • ES6 Sets / Maps
  • Date
  • RegExp
  • Types with IEquiv implementation

Status

STABLE - used in production

Installation

yarn add @thi.ng/equiv

Package sizes (gzipped): ESM: 0.5KB / CJS: 0.5KB / UMD: 0.6KB

Dependencies

None

API

Generated API docs

import { equiv } from "@thi.ng/equiv";
 
equiv(
    { a: { b: [1, 2] } },
    { a: { b: [1, 2] } }
);
// true

Implement IEquiv interface

This is useful & required for custom types to take part in equiv checks, by default only plain objects & array are traversed deeply.

Furthermore, by implementing this interface we can better control which internal values / criteria are required to establish equivalence. In this example we exclude the meta property and only check for same type & children equality.

import { IEquiv } from "@thi.ng/api";
import { equiv } from "@thi.ng/equiv";
 
class Node implements IEquiv {
 
    meta: any;
    children: any[];
 
    constructor(children: any[], meta?: any) {
        this.children = children;
        this.meta = meta;
    }
 
    equiv(o: any) {
        return o instanceof Node && equiv(this.children, o.children);
    }
}
 
equiv(new Node([1,2,3], "foo"), new Node([1,2,3], "bar"));
// true

Authors

Karsten Schmidt

License

© 2016 - 2020 Karsten Schmidt // Apache Software License 2.0

Install

npm i @thi.ng/equiv

DownloadsWeekly Downloads

2,565

Version

1.0.12

License

Apache-2.0

Unpacked Size

32.7 kB

Total Files

11

Last publish

Collaborators

  • avatar