# should-equal

> Deep comparison of 2 instances for should.js

Latest version **2.0.0** (published 2017-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install should-equal
pnpm add should-equal
yarn add should-equal
bun add should-equal
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-08-28 |
| First published | 2014-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Denis Bardadym |
| Maintainers | btd |
| Keywords | should.js, deep, equal |

## Links

- npm: https://www.npmjs.com/package/should-equal
- Repository: https://github.com/shouldjs/equal
- Issues: https://github.com/shouldjs/equal/issues
- npm.io page: https://npm.io/package/should-equal

## Dependencies (1)

- [should-type](https://npm.io/package/should-type.md) ^1.4.0

## Recent versions

- 2.0.0 (latest) — 2017-08-28
- 1.0.1 — 2016-08-09
- 1.0.0 — 2016-05-28
- 0.8.0 — 2016-05-21
- 0.7.3 — 2016-05-18
- 0.7.2 — 2016-01-27
- 0.7.1 — 2016-01-24
- 0.7.0 — 2016-01-24
- 0.6.0 — 2015-11-05
- 0.5.0 — 2015-06-18
- 0.4.3 — 2015-06-08
- 0.4.2 — 2015-06-06
- 0.4.1 — 2015-06-05
- 0.4.0 — 2015-06-05
- 0.3.1 — 2015-01-18
- … 13 more at https://npm.io/package/should-equal/versions

## README

equal
=====

[![Build Status](https://travis-ci.org/shouldjs/equal.svg?branch=master)](https://travis-ci.org/shouldjs/equal)

Deep equality comparison implementation for should.js. **Not supported outside of should.js**

Function returns an array of failed equality checks if array is empty it means objects are equal:

```js
> var eq = require('.');
undefined
> var a = {a:1,b:2,c:3,d:4,e:5,f:6,g:7,h:8,i:9,j:10},
... b = {a:1,b:2,c:3,d:4,e:5,f:6,g:7,h:7,i:9,j:10};
undefined
> eq(a, b)
[ EqualityFail {
    a: 8,
    b: 7,
    reason: 'A is not equal to B',
    path: [ 'h' ],
    showReason: false } ]
>  
```

---
_Source: https://npm.io/package/should-equal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._