• Stars
    star
    1,006
  • Rank 45,531 (Top 0.9 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 8 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Deep diffs two objects, including nested structures of arrays and objects, and returns the difference. ❄️

deep-object-diff

❄️

Deep diff two JavaScript Objects


Build Status Code coverage version downloads MIT License PRs Welcome

A small library that can deep diff two JavaScript Objects, including nested structures of arrays and objects.

Installation

yarn add deep-object-diff

npm i --save deep-object-diff

Functions available:

Importing

import { diff, addedDiff, deletedDiff, updatedDiff, detailedDiff } from 'deep-object-diff';

Usage:

diff:

const lhs = {
  foo: {
    bar: {
      a: ['a', 'b'],
      b: 2,
      c: ['x', 'y'],
      e: 100 // deleted
    }
  },
  buzz: 'world'
};

const rhs = {
  foo: {
    bar: {
      a: ['a'], // index 1 ('b')  deleted
      b: 2, // unchanged
      c: ['x', 'y', 'z'], // 'z' added
      d: 'Hello, world!' // added
    }
  },
  buzz: 'fizz' // updated
};

console.log(diff(lhs, rhs)); // =>
/*
{
  foo: {
    bar: {
      a: {
        '1': undefined
      },
      c: {
        '2': 'z'
      },
      d: 'Hello, world!',
      e: undefined
    }
  },
  buzz: 'fizz'
}
*/

addedDiff:

const lhs = {
  foo: {
    bar: {
      a: ['a', 'b'],
      b: 2,
      c: ['x', 'y'],
      e: 100 // deleted
    }
  },
  buzz: 'world'
};

const rhs = {
  foo: {
    bar: {
      a: ['a'], // index 1 ('b')  deleted
      b: 2, // unchanged
      c: ['x', 'y', 'z'], // 'z' added
      d: 'Hello, world!' // added
    }
  },
  buzz: 'fizz' // updated
};

console.log(addedDiff(lhs, rhs));

/*
{
  foo: {
    bar: {
      c: {
        '2': 'z'
      },
      d: 'Hello, world!'
    }
  }
}
*/

deletedDiff:

const lhs = {
  foo: {
    bar: {
      a: ['a', 'b'],
      b: 2,
      c: ['x', 'y'],
      e: 100 // deleted
    }
  },
  buzz: 'world'
};

const rhs = {
  foo: {
    bar: {
      a: ['a'], // index 1 ('b')  deleted
      b: 2, // unchanged
      c: ['x', 'y', 'z'], // 'z' added
      d: 'Hello, world!' // added
    }
  },
  buzz: 'fizz' // updated
};

console.log(deletedDiff(lhs, rhs));

/*
{
  foo: {
    bar: {
      a: {
        '1': undefined
      },
      e: undefined
    }
  }
}
*/

updatedDiff:

const lhs = {
  foo: {
    bar: {
      a: ['a', 'b'],
      b: 2,
      c: ['x', 'y'],
      e: 100 // deleted
    }
  },
  buzz: 'world'
};

const rhs = {
  foo: {
    bar: {
      a: ['a'], // index 1 ('b')  deleted
      b: 2, // unchanged
      c: ['x', 'y', 'z'], // 'z' added
      d: 'Hello, world!' // added
    }
  },
  buzz: 'fizz' // updated
};

console.log(updatedDiff(lhs, rhs));

/*
{
  buzz: 'fizz'
}
*/

detailedDiff:

const lhs = {
  foo: {
    bar: {
      a: ['a', 'b'],
      b: 2,
      c: ['x', 'y'],
      e: 100 // deleted
    }
  },
  buzz: 'world'
};

const rhs = {
  foo: {
    bar: {
      a: ['a'], // index 1 ('b')  deleted
      b: 2, // unchanged
      c: ['x', 'y', 'z'], // 'z' added
      d: 'Hello, world!' // added
    }
  },
  buzz: 'fizz' // updated
};

console.log(detailedDiff(lhs, rhs));

/*
{
  added: {
    foo: {
      bar: {
        c: {
          '2': 'z'
        },
        d: 'Hello, world!'
      }
    }
  },
  deleted: {
    foo: {
      bar: {
        a: {
          '1': undefined
        },
        e: undefined
      }
    }
  },
  updated: {
    buzz: 'fizz'
  }
}
*/

License

MIT

More Repositories

1

jest-expect-message

Add custom message to Jest expects 🃏🗯
JavaScript
357
star
2

babel-plugin-console

Babel Plugin that adds useful build time console functions 🎮
JavaScript
295
star
3

jest-chain

Chain Jest matchers together to create one powerful assertion 🃏⛓
JavaScript
274
star
4

babel-jest-assertions

Babel Plugin that adds safety to your tests by verifying assertions are actually ran 🃏⁉️
JavaScript
96
star
5

jest-each

A parameterised testing library for Jest. https://www.npmjs.com/package/jest-each 🏃
JavaScript
92
star
6

babel-plugin-gwt

Data Driven Testing babel plugin inspired by Groovy's Spock framework 🖖
JavaScript
14
star
7

react-point-break

React CSS media queries with breakpoint render props Component and Provider. 🔫
JavaScript
7
star
8

oss-box

Open source project boilerplate generator 📦
JavaScript
4
star
9

ts-prelude

TypeScript
3
star
10

io-ts-graphql-codegen

TypeScript
2
star
11

flow-data-structures

Basic data structures implements using Flowtype
JavaScript
2
star
12

redux-identity

A simple redux reducer that returns the given state
JavaScript
1
star
13

jest-workspace-projects

JavaScript
1
star
14

trait-contract

Utility to build a Trait (Interface) for a given Type and supply an implementation which is validated against the Trait contract
JavaScript
1
star
15

eslint-plugin-jest-extended

ESLint plugin for jest-extended matchers
JavaScript
1
star
16

data-structures

Groovy
1
star
17

es6-prototype-boilerplate

Boilerplate setup for quick prototyping with es6 using budo to build and mocha for testing.
JavaScript
1
star
18

reason-refs

C++
1
star
19

react-native-counter

JavaScript
1
star