jamesmgreene / chai-deep-match

Extends Chai with an assertion for deeply matching objects (i.e. subset equality checking)

chai-deep-match

Extends Chai with an assertion for deeply matching objects (i.e. subset equality checking).

Install

$ npm install --save chai
$ npm install --save chai-deep-match

Usage

var chai = require('chai');
var chaiDeepMatch = require('chai-deep-match');

chai.use( chaiDeepMatch );


chai.expect( { a: 'foo', b: 'bar', c: 'baz' } ).to.deep.match( { a: 'foo', c: 'baz' } );
// =>  pass

chai.expect( { a: 'foo', b: 'bar', c: 'baz' } ).to.not.deep.match( { a: 'fuzz', c: 'baz' } );
// =>  pass

Note about URL objects

This module also supports WHATWG URL objects, as introduced in Node 7.x (and backported into Node 6.x, it seems). However, it is important to note that the behavior by which it compares two URL objects will only consider them deeply matched if they are a full 100% match rather than a "subset" match. Hopefully this behavior is acceptable to those making use of it! 🙏

License

Copyright (c) 2016-2018, James M. Greene (MIT License)

chai-deep-match's Issues

keywords to increase discoverability

I wish I had found this library last year.

Try using these plugin keywords to better categorize this on the chai.js website:

• contains
• like
• similar
• subset

URL support?

const {URL} = require("url");
const url = "http://domain/";

expect( new URL(url) ).to.deep.match( new URL(url) );
expect({ key:new URL(url) }).to.deep.match({ key:new URL(url) });  // throws

Array transforms to object in assertion error message

Property 'match' does not exist on type 'Deep'.

src/tests/test.ts:274:34 - error TS2339: Property 'match' does not exist on type 'Deep'.

274       expect(obj).to.be.deep.match(fixture);

Can it work with typescript?

cross-realm RegExp support

Object.prototype.toString.call(expected) !== '[object RegExp]'

Upgrade peer dependency to chai v4

When installing chai-deep-match latest, we get:

warning "[email protected]" has incorrect peer dependency "chai@>=2.1.2 <4"

However it seems to work fine with chai 4.*

duplicate of chai-subset?

This seems to be a duplicate plugin of http://chaijs.com/plugins/chai-subset/ or am I missing something?