compare-obj

Recursively compare 2 objects on a property bases to get the difference

Table of Contents

• About
• Features
• Usage
• Install
• Contribute
• License

About

Explain the problem the package is trying to solve.

Features

• Name key features e.g. size, performance, how it differs from similar solutions etc.

Usage

const compare = require('compare-obj')

const data = {
  id: 'foobarbaz',
  name: 'Bazzy',
  contactNumber: '0000000',
  contactIds: ['one', 'two', 'three']
}

const initialValues = {
  id: 'foobarbaz',
  name: 'Bazzy',
  contactIds: ['one', 'two']
}

console.log(compare(data, initialValues))
// { contactNumber: '0000000', contactIds: [ 'three' ] }

Install

This project uses node and npm.

$ npm install compare-obj
$ # OR
$ yarn add compare-obj

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Commit your changes: git commit -am "Add some feature"
3. Push to the branch: git push origin my-new-feature
4. Submit a pull request

License

MIT