Ignore keys which have undefined values to compare from a deep equal operation with chai expect
npm install chai-equal-ignore-undefined-properties
Ignore keys with undefined value to compare from a deep equal operation with chai expect.
Sometimes you will have properties which have undefined value. This plugin helps to ignore those properties from comparison.
Works with both objects and array of objects with or without circular references.
``bash`
npm install chai-equal-ignore-undefined-properties --save-dev
`bash`
yarn add chai-equal-ignore-undefined-properties --dev
`js
const chai = require("chai");
const chaiIgnoreUndefinedProperties = require("chai-equal-ignore-undefined-properties");
chai.use(chaiIgnoreUndefinedProperties);
`
`js
import chai from "chai";
import chaiIgnoreUndefinedProperties from "chai-equal-ignore-undefined-properties";
chai.use(chaiIgnoreUndefinedProperties);
`
`js
import * as chai from "chai";
import chaiIgnoreUndefinedProperties from "chai-equal-ignore-undefined-properties";
chai.use(chaiIgnoreUndefinedProperties);
// The typings for chai-equal-ignore-undefined-properties are included with the package itself.
`
All these examples are for JavaScript.
1. Ignore a top level property from an object
`js`
expect({ aa: undefined, bb: "b" }).to.equal({
bb: "b",
cc: undefined,
});
2. Ignore properties within array with undefined values
`js`
const expectedArray = [{ aa: undefined, bb: "b" }];
const actualArray = [{ cc: undefined, bb: "b" }];
expect(actualArray).to.deep.equal(expectedArray);
3. Ignore a nested properties with undefined value (only for deep equal comparison)
`js`
expect({
topLevelProp: { aa: undefined, bb: "b" },
}).to.deep.equal({
topLevelProp: { bb: "b", cc: undefined },
});
4. Works with circular dependencies
`js
const actualObject = { aa: undefined, bb: "b" };
actualObject.c = actualObject;
const expectedObject = { bb: "b", cc: undefined };
expectedObject.c = expectedObject;
expect(actualObject).to.deep.equal(expectedObject);
``
Contributions are welcome. If you have any questions create an issue here.