https://github.com/digitalbrainjs/isequalobjects
Check whether objects are equal in deep
https://github.com/digitalbrainjs/isequalobjects
Last synced: about 1 year ago
JSON representation
Check whether objects are equal in deep
- Host: GitHub
- URL: https://github.com/digitalbrainjs/isequalobjects
- Owner: DigitalBrainJS
- License: mit
- Created: 2019-10-08T16:10:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-29T08:24:19.000Z (over 1 year ago)
- Last Synced: 2025-04-11T04:13:25.737Z (about 1 year ago)
- Language: JavaScript
- Size: 281 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# is-equal-objects
[](https://travis-ci.com/DigitalBrainJS/isEqualObjects)
[](https://unpkg.com/is-equal-objects/dist/is-equal-objects.umd.js)
[](https://unpkg.com/is-equal-objects/dist/is-equal-objects.umd.js)
[](https://unpkg.com/is-equal-objects/dist/is-equal-objects.umd.js)
[](https://github.com/DigitalBrainJS/isEqualObjects/issues)
[](https://github.com/DigitalBrainJS/isEqualObjects/stargazers)
[](https://coveralls.io/github/DigitalBrainJS/isEqualObjects?branch=master)
Check whether objects are equal in deep. Useful for checking options objects.
# Features
- Arrays and flat objects (whose constructor is Object and _proto_ is Object.prototype) will be deeply tested
- NaN === NaN
- Date, Regexp will be checked by reference or value, other complex objects will be simply compared by reference
- Circular references to objects will be compared by reference
- No dependencies
- CDN friendly
## Installation
Install for node.js or browserify using npm/yarn:
``` bash
$ npm install is-equal-objects --save
```
``` bash
$ yarn add is-equal-objects
```
````javascript
import isEqualObjects from 'is-equal-objects/esm';
//OR
const isEqualObjects= require('is-equal-objects');
````
## CDN
Use unpkg.com cdn to get the link to the script/module from the package:
- minified UMD ES5 version (~1kB)
```html
isEqualObjects({x:1}, {x:1})//true
```
- ESM ES2015 module(~2kB)
```javascript
import {isEqualObjects, cloneObject} from "https://unpkg.com/is-equal-objects/dist/is-equal-objects.esm.js"
//or minified version
import {isEqualObjects, cloneObject} from "https://unpkg.com/is-equal-objects/dist/is-equal-objects.esm.min.js"
```
## Usage examples
Basic usage:
````javascript
isEqualObjects(1, 1); //true
isEqualObjects({x:1}, {x:1}); //true
isEqualObjects({x:1}, {x:1}, {x:1}); //true
isEqualObjects([{x:1}], [{x:1}]); //true
isEqualObjects([{x:[1]}], [{x:[1]}]); //true
const complexObj= Object.create({});
Object.assign(complexObj, {x:1});
isEqualObjects({x:1}, complexObj); //false, complexObj is not a flat object, test by reference
isEqualObjects(new Date(1995, 11, 17), new Date(1995, 11, 17)); //true
isEqualObjects(/\s+/, /\s+/); //true
isEqualObjects(
Object.create({
[isEqualObjects.plainObject]: true,
x: 123
}),
Object.create({
[isEqualObjects.plainObject]: true,
x: 123
})
); // true
isEqualObjects.call({
comparator(obj1, obj2){
return obj1.x === obj2.x;
}
}, {x: 123, ignoredProp: 456}, {x:123, ignoredProp: 987});
// cloneObject usage
const sourceObj= {x: {y: new Date()}};
const clonedObject = cloneObject(sourceObj);
console.log(sourceObj.x === clonedObj.x); // false
console.log(sourceObj.x.y === clonedObj.x.y); // false
console.log(isEqualObjects(sourceObj, clonedObject)); // true
````
## API
### isEqualObjects(...objects: any): Boolean
- `...objects` objects to check
**returns** `false`, if the objects are not deeply equal, `true` otherwise
Additional options can be passed via function context (`this`):
- `comparator(obj1: any, obj2: any): boolean|undefined` - a custom object comparator
### cloneObject(obj: any): any
- `obj` any object to clone
**returns** a deep copy of the object
## Contribution
Feel free to fork, open issues, enhance or create pull requests.
## License
The MIT License
Copyright (c) 2019 Dmitriy Mozgovoy
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.