modernized code and updated equal functions

Added skipProperties parameter for areObjectsEqual.
Added .npmignore file.
Added minify to packages scripts.
Added more unit tests.
Updated getObjectsDiff to handle empty arrays and return an object, even if it’s empty object.
Updated readme file.

Author: BonneVoyager

.npmignore

@@ -0,0 +1,2 @@
+*.spec.js
+yarn.lock

README.md

@@ -1,38 +1,44 @@
 # nested-objects-util
 
-A module to filter and diff complex nested objects having circular references.
+A minimalist inspection module to filter and diff complex nested objects having circular references.
 
 It was implemented to filter out some values from inconveniently nested objects with circular references and then diff them.
 
-It's designed to work both on nodejs and browser without any dependencies.
+It's designed to work both on nodejs and browser without any dependencies or additional polyfills.
+
+Performance is currently not the key feature of this module, so please use more optimised libraries for e.g. deep equal.
 
 ## Installation
 
 ```
 npm install --save nested-objects-util
+
+yarn add nested-objects-util
 ```
 
+Or just copy `index.min.js` into the console and start using `NestedObjectsUtil` object.
+
 ## Usage
 
 ```js
-const nestedObjectsUtil = require('nested-objects-util');
+const nestedObjectsUtil = require('nested-objects-util')
 ```
 
-#### nestedObjectsUtil.flatten(Object: object, Boolean: sortKeysFlag = false): Object
+#### nestedObjectsUtil.flatten(object: object, sortKeysFlag = false): object
 
 Flatten object by keys composed from own nested properties.
 
 ```js
 nestedObjectsUtil.flatten({
   keyA: {
-    keyE: [ 'value3', 'value4' ],
+    keyE: ['value3', 'value4'],
     keyF: null,
     keyD: 'value2',
     keyB: {
       keyC: 'value'
     }
   }
-});
+})
 ```
 
 returns:
@@ -59,15 +65,15 @@ with sortKeys=true it would return:
 }
 ```
 
-#### nestedObjectsUtil.unflatten(Object: object): Object
+#### nestedObjectsUtil.unflatten(object: object): object
 
 Unflatten object by keys composed from own nested properties.
 
 ```js
 nestedObjectsUtil.unflatten({
   'keyA.keyB.keyC': 'value',
   'keyA.keyD': 'value2'
-});
+})
 ```
 
 returns:
@@ -79,11 +85,11 @@ returns:
       "keyC": "value"
     },
     "keyD": "value2"
-    }
   }
+}
 ```
 
-#### nestedObjectsUtil.accessProperty(String | Array: keys, Object: parent = global | window): Various
+#### nestedObjectsUtil.accessProperty(keys: string|string[], parent = global window): any
 
 Access object's nested property.
 
@@ -94,8 +100,8 @@ const nestedObject = {
       keyC: 'value'
     }
   }
-};
-nestedObjectsUtil.accessProperty('keyA.keyB.keyC', nestedObject);
+}
+nestedObjectsUtil.accessProperty('keyA.keyB.keyC', nestedObject)
 ```
 
 returns:
@@ -104,15 +110,15 @@ returns:
 "value"
 ```
 
-#### nestedObjectsUtil.discardCircular(Object: object, Boolean: stringifyFlag = false): Object | String
+#### nestedObjectsUtil.discardCircular(object: object, stringifyFlag = false): object|string
 
 Discard circular references (to avoid "Converting circular structure to JSON" error).
 
 ```js
 const a = {
   b: 1
-};
-a.c = a;
+}
+a.c = a
 nestedObjectsUtil.discardCircular(a)
 ```
 
@@ -125,7 +131,7 @@ returns:
 }
 ```
 
-#### nestedObjectsUtil.filterValue(Object: object, Various | Array: query, Boolean: flattenFlag = false): Object
+#### nestedObjectsUtil.filterValue(object: object, query: any|any[], flattenFlag = false): object
 
 Filter a nested object by value or values (if array passed). Strict comparison is performed.
 
@@ -143,10 +149,10 @@ const a = {
     },
     j: 'str4'
   },
-  k: [ 'str', 'str5' ]
-};
-a.l = a.b;
-nestedObjectsUtil.filterValue(a, 'str');
+  k: ['str', 'str5']
+}
+a.l = a.b
+nestedObjectsUtil.filterValue(a, 'str')
 ```
 
 returns:
@@ -162,14 +168,14 @@ returns:
       "h": "str"
     }
   },
-  "k": [ "str" ]
+  "k": ["str"]
 }
 ```
 
 or with flattenFlag = true
 
 ```js
-nestedObjectsUtil.filterValue(a, 'str', true);
+nestedObjectsUtil.filterValue(a, 'str', true)
 ```
 
 returns:
@@ -183,7 +189,7 @@ returns:
 }
 ```
 
-#### nestedObjectsUtil.downloadStringified(Object: object, Number: space = 2): String | undefined
+#### nestedObjectsUtil.downloadStringified(object: object, space = 2): string|undefined
 
 On browser with HTML5 download API: stringify, format and download the object.
 
@@ -196,11 +202,11 @@ const a = {
     d: 2,
     e: 2
   }
-};
-a.f = a;
-a.g = a.f;
-const obj = nestedObjectsUtil.discardCircular(a);
-nestedObjectsUtil.downloadStringified(obj);
+}
+a.f = a
+a.g = a.f
+const obj = nestedObjectsUtil.discardCircular(a)
+nestedObjectsUtil.downloadStringified(obj)
 ```
 
 returns:
@@ -217,9 +223,9 @@ returns:
 }
 ```
 
-#### nestedObjectsUtil.areObjectsEqual(Object: objectA, Object: objectB): Boolean
+#### nestedObjectsUtil.areObjectsEqual(objectA: object, objectB: object, skipProperties?: string[]): boolean
 
-Compare two objects against each other (by JSON.stringify) after discarding circular references, flattening and ordering keys.
+Compare two objects against each other after discarding circular references, flattening and ordering keys.
 
 ```js
 const objectA = {
@@ -228,21 +234,21 @@ const objectA = {
       keyC: 'value'
     },
     keyD: 'value2',
-    keyE: [ 'value3', 'value4' ]
+    keyE: ['value3', 'value4']
   }
-};
-objectA.circular = objectA;
+}
+objectA.circular = objectA
 const objectB = {
   keyA: {
-    keyE: [ 'value3', 'value4' ],
+    keyE: ['value3', 'value4'],
     keyD: 'value2',
     keyB: {
       keyC: 'value'
     }
   }
-};
-objectB.circular = objectB;
-nestedObjectsUtil.areObjectsEqual(objectA, objectB);
+}
+objectB.circular = objectB
+nestedObjectsUtil.areObjectsEqual(objectA, objectB)
 ```
 
 returns:
@@ -251,7 +257,39 @@ returns:
 true
 ```
 
-#### nestedObjectsUtil.getObjectsDiff(Object: objectA, Object: objectB, Boolean: sortKeysFlag = false, Boolean: flattenFlag = false): Object
+It is also possible to skip certain properties when comparing the objects by providing an array to string properties.
+
+```js
+const objectA = {
+  keyA: {
+    keyB: {
+      keyC: 'value'
+    },
+    keyD: 'value2',
+    keyE: ['value3', 'value4']
+  }
+}
+objectA.circular = objectA
+const objectB = {
+  keyA: {
+    keyB: {
+      keyC: 'DIFFERENT_VALUE'
+    },
+    keyD: 'value2',
+    keyE: ['value3', 'value4']
+  }
+}
+objectB.circular = objectB
+nestedObjectsUtil.areObjectsEqual(objectA, objectB, ['keyA.keyB.keyC'])
+```
+
+returns:
+
+```js
+true
+```
+
+#### nestedObjectsUtil.getObjectsDiff(objectA: object, objectB: object, sortKeysFlag = false, flattenFlag = false): object
 
 Get the properties which differ between object A and object B and return only those from object B.
 
@@ -262,21 +300,21 @@ const objectA = {
       keyC: 'value'
     },
     keyD: 'value2',
-    keyE: [ 'value3' ]
+    keyE: ['value3']
   }
-};
-objectA.circular = objectA;
+}
+objectA.circular = objectA
 const objectB = {
   keyA: {
     keyB: {
       keyC: 'value'
     },
     keyD: 'value2_CHANGED',
-    keyE: [ 'value3_CHANGED' ]
+    keyE: ['value3_CHANGED']
   }
-};
-objectB.circular = objectB;
-nestedObjectsUtil.getObjectsDiff(objectA, objectB);
+}
+objectB.circular = objectB
+nestedObjectsUtil.getObjectsDiff(objectA, objectB)
 ```
 
 returns:
@@ -285,7 +323,7 @@ returns:
 {
   "keyA": {
     "keyD": "value2_CHANGED",
-    "keyE": [ "value3_CHANGED" ]
+    "keyE": ["value3_CHANGED"]
   }
 }
 ```
@@ -297,22 +335,24 @@ In the browser, NestedObjectsUtil object is exposed either to window or with AMD
 Filter out 'abcd' value from the flattened object and download stringified JSON via HTML5 API with:
 
 ```js
-const object = NestedObjectsUtil.filterValue(App.SomeHugeObject, 'abcd', true);
-NestedObjectsUtil.downloadStringified(object);
+const object = NestedObjectsUtil.filterValue(App.SomeHugeObject, 'abcd', true)
+NestedObjectsUtil.downloadStringified(object)
 ```
 
 Discar circular references from the object, then flatten and download it.
 
 ```js
-let object = NestedObjectsUtil.discardCircular(App.SomeHugeObject);
-object = NestedObjectsUtil.flatten(object);
-NestedObjectsUtil.downloadStringified(object);
+let object = NestedObjectsUtil.discardCircular(App.SomeHugeObject)
+object = NestedObjectsUtil.flatten(object)
+NestedObjectsUtil.downloadStringified(object)
 ```
 
 ## Test
 
 ```
 npm run test
+
+yarn test
 ```
 
 ## License