Giter VIP home page Giter VIP logo

deep-match's Introduction

Build Status

Check if two values deeply match

deepMatch(object, example)

All properties and nested objects mentioned in the example are required to be present in object.

// two objects that look exactly the same
deepMatch({ a: 1, b: 2 } }, { a: 1, b: 2 }); // true

// additional properties on the left-hand side are ignored
deepMatch({ a: 1, b: 2 } }, { a: 1 }); // true

// everything on the right-hand side is required
deepMatch({ a: 1 } }, { a: 1, b: 2 }); // false

// same for arrays
deepMatch([1, 2, 3], [1, 2]); // true
deepMatch([1, 2, 3], [3, 4]); // false

Regular expressions and functions in the example are run against the corresponding values in the object:

deepMatch('aaa', /a+/); // true
deepMatch('bbb', /a+/); // false
deepMatch(['aaa', 'bbb'], [/a+/]); // true
deepMatch(['aaa', 'bbb'], [/a+/, /b+/]); // true
deepMatch(['aaa', 'ccc'], [/a+/, /b+/]); // false
deepMatch([1, 2, 3], [v => v === 1]); // true

When matching arrays order of items do not matters by default. To change it you can use additional parameter:

let opts = { arrayOrderMatters: true };
deepMatch([1, 2], [1, 2], opts); // true
deepMatch([1, 2], [2, 1], opts); // false
deepMatch([1, 2], [   2], opts); // false

// disable checks for undefined items
// [,2] is the same as [undefined, 2]
deepMatch([1, 2], [ , 2], opts); // true

// arrayOrderMatters applies also to nested arrays:
source  = { a1: [ {i1: []}, {i2: [1, 2,         [31, 32, 33], 4, 5]} ]};
matcher = { a1: [ {i1: []}, {i2: [1, undefined, [32, 33    ],  , 5]} ]};
deepMatch(source, matcher, opts); // false
deepMatch(source, matcher);       // false

// Note that in case of arrayOrderMatters=false undefined is not skipped
source  = { a1: [ {i1: []}, {i2: [1, 2,         [31, 32,        33], 4, 5]} ]};
matcher = { a1: [ {i1: []}, {i2: [1, undefined, [31, undefined, 33],  , 5]} ]};
deepMatch(source, matcher, opts); // true
deepMatch(source, matcher);       // false

Rules

Values are compared according to the following rules:

  • Identical values always match.
  • Values of different types never match.
  • Values that are no objects only match if they are identical (see above).
  • Null values (which are also objects) only match if both are null.
  • Arrays match if all items in the example match (note different behavior for option arrayOrderMatters).
  • When arrayOrderMatters=true value of undefined matchers are skipped.
  • When arrayOrderMatters=false (default behavior) value of undefined matchers are NOT skipped.
  • Objects match if all properties in the example match.

License

MIT

deep-match's People

Contributors

dependabot[bot] avatar fgnass avatar fider avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

ataube fider

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.