human-object-diff

human-object-diff

Configurable Human Readable Difference Between Two Plain Objects

Table of Contents

• Install
• Usage
  • Support for Dates
• Contributors
• License

Install

npm:

npm install human-object-diff

yarn:

yarn add human-object-diff

Usage

const humanDiff = require('human-object-diff');

const lhs = { foo: 'bar' };
const rhs = { foo: 'baz' };
const options = {};

const diff = humanDiff(lhs, rhs, options);

console.log(humanObjectDiff.renderName());
// -> ['Foo", with a value of "bar" (at Obj.foo) was changed to "baz"']

Support for Dates

human-object-diff uses date-fns format function under the hood to show human readable date differences. We also supply a dateFormat option where you can supply your own date formatting string. Please note, that date-fns format strings are different from moment.js format strings. Please refer to the documentation here and here

Contributors

Name	Website
Spencer Snyder	http://spencersnyder.io/

License

MIT © Spencer Snyder