is-equal-shallow
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
var equals = require('is-equal-shallow');
equals(object_a, object_b);
Examples
equals({a: true, b: true}, {a: true, b: true});
equals({a: true, b: false}, {c: false, b: false});
equals({a: true, b: false}, {a: false, b: false});
Strict comparison for equality:
equals({a: true, b: true}, {a: true, b: 'true'});
When values are not primitives, false
is always returned:
equals({ b: {}}, { b: {}});
equals({ b: []}, { b: []});
Run 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 (c) 2015 Jon Schlinkert
Released under the MIT license
This file was generated by verb on February 25, 2015.