is-equal/README.md

Are these two values conceptually equal?

# is-equal <sup>[![Version Badge][2]][1]</sup>

[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![dependency status][5]][6]
[![dev dependency status][7]][8]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][11]][1]

Are these two values conceptually equal?

## Example

```js
var isEqual = require('is-equal');
var assert = require('assert');

var primitives = [true, false, undefined, 42, 'foo'];
primitives.forEach(function (primitive) {
	assert.equal(isEqual(primitive, primitive), true);
});
assert.equal(isEqual(/a/g, /a/g), true);
assert.equal(isEqual(/a/g, new RegExp('a', 'g')), true);
assert.equal(isEqual({ a: 2 }, { a: 2 }), true);
assert.equal(isEqual([1, [2, 3], 4], [1, [2, 3], 4]), true);
var timestamp = Date.now();
assert.equal(isEqual(new Date(timestamp), new Date(timestamp)), true);
```

## Want to know *why* two values are not equal?
Will return an empty string if `isEqual` would return `true` - otherwise will return a non-empty string that hopefully explains the reasoning.

```
var whyNotEqual = require('is-equal/why');

assert.equal(whyNotEqual(1, 1), '');
assert.equal(
  whyNotEqual({ a: 1 }, { a: 2 }),
  'value at key "a" differs: numbers are different: 1 !== 2'
);
```

## Tests
Simply clone the repo, `npm install`, and run `npm test`

[1]: https://npmjs.org/package/is-equal
[2]: https://versionbadg.es/inspect-js/is-equal.svg
[5]: https://david-dm.org/inspect-js/is-equal.svg
[6]: https://david-dm.org/inspect-js/is-equal
[7]: https://david-dm.org/inspect-js/is-equal/dev-status.svg
[8]: https://david-dm.org/inspect-js/is-equal#info=devDependencies
[11]: https://nodei.co/npm/is-equal.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/is-equal.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/is-equal.svg
[downloads-url]: https://npm-stat.com/charts.html?package=is-equal
[codecov-image]: https://codecov.io/gh/inspect-js/is-equal/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/inspect-js/is-equal/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-equal
[actions-url]: https://github.com/inspect-js/is-equal/actions