equals

equals

compare values of any complexity for equivalence

Getting Started

With component, packin or npm

$ {package mananger} install jkroso/equals

then in your app:

var equals = require('equals')

API

• equals()
• compare()

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 to undefined.
• NaN is equal to NaN (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

Running the tests

$ npm install
$ make test