@snaplib/compare v0.1.6

Compare

Compare 2 objects to each other.

This npm package exports the Compare class.

Compare class

The Compare class consumes 2 objects and provides methods to query the differences and similarities between the consumed objects. To differentiate between the 2 consumed objects, one object is referred to as the source object and the other object it's being compared to is referred to as the target object.

There are 4 different types of "relation" queries Compare objects contain:

1. omittedProperties

   Properties that are present in the source object but not in the target object.

2. extraProperties

   Properties that are not present in the source object but are present in the target object.

3. sharedProperties

   Properties that are present in both the source and target object that are mapped to equivalent values.

4. alteredProperties

   Properties that are present in both the source and target object that are mapped to differing values.

Examples

Below are a few examples highlighting how each query behaves:

const car = {
    numOfWheels: 4,
    fuel: "petrol",
    makes: ["Koenigsegg", "Pagani"],
    bodyTypes: ["coup", "sedan", "suv"],
    engineLocations: ["front", "middle", "rear"],
    isSafe: true
}

const motorcycle = {
    numOfWheels: 2,
    fuel: "petrol",
    makes: ["MV Agusta", "Triumph"],
    driveTypes: ["chain", "belt", "shaft"],
    isSafe: false
}

// Pass `car` as the source object to compare to `motorcycle` as the target
// object
const objectComparison = new Compare(car, motorcycle);

console.log(objectComparison.omittedProperties);
/*
 * prints the properties that are in the `car` object but not in the
 * `motorcycle` object`:
 *
 * {
 *   bodyTypes: ["coup", "sedan", "suv"],
 *   engineLocations: ["front", "middle", "rear"]
 * }
 */

console.log(objectComparison.extraProperties);
/*
 * prints the properties that are not in the `car` object but are present in the
 * `motorcycle` object`:
 *
 * {
 *   driveTypes: ["chain", "belt", "shaft"]
 * }
 */

console.log(objectComparison.sharedProperties);
/*
 * prints the properties that are both present and equal in both the `car`
 * and `motorcycle` object:
 *
 * {
 *   fuel: "petrol"
 * }
 */

console.log(objectComparison.alteredProperties)
/*
 * prints the properties that have the same key in both the `car` and
 * `motorcycle` object but are mapped to differing values. The keys along with
 * differing values from both the `car` and `motorcycle` object are included:
 *
 * {
 *   numOfWheels: {sourceValue: 4, targetValue: 2},
 *   makes: { sourceValue: ["Koenigsegg", "Lamborghini],
 *            targetValue: ["MV Agusta", "Triumph"] },
 *   isSafe: {sourceValue: true, targetValue: false}
 * }
 */

This class is intended to be used for analyzing/reading as opposed to mutating/altering. As a result the objects returned by Compare objects are immutable and attempting to mutate them will result in an error.

It should also be noted that the Compare class is intended to compare objects or values that can be interpreted as objects and contain enumerable properties (key-value pairs). Attempting to construct a Compare object with null, undefined, or non-string primitive values as source and/or target arguments will result in, ideally, an error to be thrown or undefined behavior.