chai-equal-ignore-undefined-properties
Ignore keys with undefined value to compare from a deep equal operation with chai expect.
Why?
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.
Installation
npm install chai-equal-ignore-undefined-properties --save-dev
yarn add chai-equal-ignore-undefined-properties --dev
Usage
Require
const chai = require("chai");
const chaiIgnoreUndefinedProperties = require("chai-equal-ignore-undefined-properties");
chai.use(chaiIgnoreUndefinedProperties);
ES6 Import
import chai from "chai";
import chaiIgnoreUndefinedProperties from "chai-equal-ignore-undefined-properties";
chai.use(chaiIgnoreUndefinedProperties);
TypeScript
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.
Examples
All these examples are for JavaScript.
a) excluding
- Ignore a top level property from an object
expect({ aa: undefined, bb: "b" }).to.equal({
bb: "b",
cc: undefined,
});
- Ignore properties within array with undefined values
const expectedArray = [{ aa: undefined, bb: "b" }];
const actualArray = [{ cc: undefined, bb: "b" }];
expect(actualArray).to.deep.equal(expectedArray);
- Ignore a nested properties with undefined value (only for deep equal comparison)
expect({
topLevelProp: { aa: undefined, bb: "b" },
}).to.deep.equal({
topLevelProp: { bb: "b", cc: undefined },
});
- Works with circular dependencies
const actualObject = { aa: undefined, bb: "b" };
actualObject.c = actualObject;
const expectedObject = { bb: "b", cc: undefined };
expectedObject.c = expectedObject;
expect(actualObject).to.deep.equal(expectedObject);
Contributing
Contributions are welcome. If you have any questions create an issue here.