equals
Check if two values are deeply equivalent
npm install equals
Want to see pretty graphs? Log in now!
7 | downloads in the last day |
41 | downloads in the last week |
63 | downloads in the last month |
Last Published By | |
---|---|
Version | 0.3.6 last updated 2 months ago |
License | MIT |
Keywords | equality, equal, same, equivalent, equivalence, = |
Repository | git://github.com/jkroso/equals.git (git) |
Homepage | https://github.com/jkroso/equals |
Bugs | https://github.com/jkroso/equals/issues |
Dependencies | type |
Dependents | jsedn, obs-model-validation |
equals
compare values of any complexity for equivalence
Installation
With your favorite package manager:
then in your app:
var equals = require('equals')
API
equals(...)
equals takes as many arguments as you like of any type you like and returns a boolean result. Primitive types are equal if they are equal. While composite types, i.e. Objects and Arrays, are considered equal if they have both the same structure and the same content. Specifically that means the same set of keys each pointing to the same values. Composite structures can be as big as you like and and circular references are perfectly safe.
Same structure:
equals(
{ a : [ 2, 3 ], b : [ 4 ] },
{ a : [ 2, 3 ], b : [ 4 ] }
) // => true
Different Structure:
equals(
{ x : 5, y : [6] },
{ x : 5}
) // => false
Same structure, different values:
equals(
{ a: [ 1, 2 ], b : [ 4 ]},
{ a: [ 2, 3 ], b : [ 4 ]}
) // => false
Primitives:
equals(new Date(0), new Date(0), new Date(1)) // => false
Some possible gotchas:
null
is not equal toundefined
.NaN
is equal toNaN
(normally not the case).-0
is equal to+0
.- Strings will not coerce to numbers.
- Non enumerable properties will not be checked. They can't be.
arguments.callee
is not considered when comparing arguments
compare(a, b)
compare two values.
equals.compare({}, {}) // => true