Does a shallow comparison of two objects, returning false if the keys or values differ.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig update Feb 25, 2015
.gitattributes
.gitignore update Feb 25, 2015
.jshintrc update Feb 25, 2015
.travis.yml update Feb 25, 2015
.verb.md related projects Jun 23, 2015
LICENSE
README.md Add example for es6 import Mar 22, 2016
index.js Fix failing behavior if one object is a subset of the other Apr 14, 2015
package.json 0.1.3 Jun 23, 2015
test.js lint Jun 23, 2015

README.md

is-equal-shallow NPM version Build Status

Does a shallow comparison of two objects, returning false if the keys or values differ.

The purpose of this lib is to do the fastest comparison possible of two objects when the values will predictably be primitives.

  • only compares objects.
  • only compares the first level of each object
  • values must be primitives. If a value is not a primitive, even if the values are the same, false is returned.

Install with npm

$ npm i is-equal-shallow --save

Usage

// legacy cjs require
var equals = require('is-equal-shallow');
// use es6 import
import equals from 'is-equal-shallow';

equals(object_a, object_b);

Examples

equals({a: true, b: true}, {a: true, b: true});
//=> 'true'

equals({a: true, b: false}, {c: false, b: false});
//=> 'false'

equals({a: true, b: false}, {a: false, b: false});
//=> 'false'

Strict comparison for equality:

equals({a: true, b: true}, {a: true, b: 'true'});
//=> 'false'

When values are not primitives, false is always returned:

equals({ b: {}}, { b: {}});
//=> 'false'

equals({ b: []}, { b: []});
//=> 'false'

Related projects

Other object utils:

  • clone-deep: Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives.
  • for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
  • for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
  • is-plain-object: Returns true if an object was created by the Object constructor.
  • isobject: Returns true if the value is an object and not an array or null.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on June 22, 2015.