# neatequal

> Neat deep equal.

Latest version **1.0.0** (published 2015-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install neatequal
pnpm add neatequal
yarn add neatequal
bun add neatequal
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-02-07 |
| First published | 2015-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Nicolas Froidure |
| Maintainers | nfroidure |
| Keywords | assert, deepEqual, neat |

## Links

- npm: https://www.npmjs.com/package/neatequal
- Repository: git@github.com:nfroidure/neatequal
- Homepage: https://github.com/nfroidure/neatequal
- Issues: https://github.com/nfroidure/neatequal/issues
- npm.io page: https://npm.io/package/neatequal

## Dependencies (1)

- [varstream](https://npm.io/package/varstream.md) ^0.3.2

## Recent versions

- 1.0.0 (latest) — 2015-02-07

## README

# neatequal

`neatequal` is a neater deepEqual.

[![NPM version](https://badge.fury.io/js/neatequal.png)](https://npmjs.org/package/neatequal) [![Build status](https://secure.travis-ci.org/nfroidure/neatequal.png)](https://travis-ci.org/nfroidure/neatequal) [![Dependency Status](https://david-dm.org/nfroidure/neatequal.png)](https://david-dm.org/nfroidure/neatequal) [![devDependency Status](https://david-dm.org/nfroidure/neatequal/dev-status.png)](https://david-dm.org/nfroidure/neatequal#info=devDependencies) [![Coverage Status](https://coveralls.io/repos/nfroidure/neatequal/badge.png?branch=master)](https://coveralls.io/r/nfroidure/neatequal?branch=master) [![Code Climate](https://codeclimate.com/github/nfroidure/neatequal.png)](https://codeclimate.com/github/nfroidure/neatequal)

![neatEqual capture](https://pbs.twimg.com/media/BdkpqTjCEAAOipY.png:large)

## Installation

First install `neatequal` in you project:
```sh
npm install --save neatequal
```

## Getting started

Then, use it:

```js
var neatequal = require('neatequal');

var expectedFruits = [{
  name: 'orange'
  count: 2,
  colors: ['orange']
}, {
	name: 'banana',
  count: 0,
  colors: ['yellow', 'white']
}, {
	name: 'kiwi',
  count: 8,
  colors: ['brown', 'green']
}];

var currentFruits = [{
  name: 'orange'
  count: 2,
  colors: ['yellow', 'orange']
}, {
	name: 'banana',
  count: 1,
  colors: ['white']
}];

neatequal(expectedFruits, currentFruits);
```


## API

### neatequal(current:Object, expected:Object)
Throws an exception if current and expected objects doens'nt equal.

## Contribute

Feel free to submit us your improvements. To do so, you must accept to publish
 your code under the MIT license.

To start contributing, first run the following to setup the development
 environment:
```sh
git clone git@github.com:nfroidure/neatequal.git
cd neatequal
npm install
```

Then, run the tests:
```sh
npm test
```

## Stats
[![NPM](https://nodei.co/npm/neatequal.png?downloads=true&stars=true)](https://nodei.co/npm/neatequal/)
[![NPM](https://nodei.co/npm-dl/neatequal.png)](https://nodei.co/npm/neatequal/)

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