forked from enviPath/enviPy
Current Dev State
This commit is contained in:
77
static/js/ketcher2/node_modules/neatequal/README.md
generated
vendored
Normal file
77
static/js/ketcher2/node_modules/neatequal/README.md
generated
vendored
Normal file
@ -0,0 +1,77 @@
|
||||
# neatequal
|
||||
|
||||
`neatequal` is a neater deepEqual.
|
||||
|
||||
[](https://npmjs.org/package/neatequal) [](https://travis-ci.org/nfroidure/neatequal) [](https://david-dm.org/nfroidure/neatequal) [](https://david-dm.org/nfroidure/neatequal#info=devDependencies) [](https://coveralls.io/r/nfroidure/neatequal?branch=master) [](https://codeclimate.com/github/nfroidure/neatequal)
|
||||
|
||||

|
||||
|
||||
## 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
|
||||
[](https://nodei.co/npm/neatequal/)
|
||||
[](https://nodei.co/npm/neatequal/)
|
||||
|
||||
Reference in New Issue
Block a user