@cleverbrush/deep 0.0.2 → 0.0.3

package/README.md

@@ -0,0 +1,61 @@
+# Deep operation on objects
+
+This is yet another library which provides operations over JavaScript objects, like deep compare and deep merge.
+
+## Installation
+
+    npm install @cleverbrush/deep
+
+## Usage
+
+    const deep = require('@cleverbrush/deep');
+
+or for ES Module
+
+    import deep from '@cleverbrush/deep';
+    // or import functions individually
+    import { deepEqual, deepExtend } from '@cleverbrush/deep';
+
+## Functions
+
+### deepEqual
+
+Takes two objects as parameters, compares it recursively and returns `true` if they are equal or `false` in other case.
+
+    import { deepEqual } from '@cleverbrush/deep';
+
+    const equal1 = deepEqual({ a: {b : 1} }, { a: {b: 1} });
+    // equal1 === true
+
+    const equal2 = deepEqual({ a: {b : 1} }, { a: {b: 20} });
+    // equal2 === false
+
+    const equal3 = deepEqual({ a: {b : 1, c: 2} }, { a: {b: 20} });
+    // equal3 === false
+
+### deepExtend
+
+Works similary to `Object.extend`, but respects the deep structure of objects.
+
+    import { deepExtend } from '@cleverbrush/deep';
+
+    deepExtend({}, {
+            a: 'something,
+            name: {
+                first: 'Ivan'
+            }
+        }, {
+            name: {
+                last: 'Ivanov'
+            }
+        });
+
+will return the following object:
+
+    {
+        a: 'something',
+        name: {
+            first: 'Ivan',
+            last: 'Ivanov'
+        }
+    }

package/dist/deepEqual.js

@@ -39,8 +39,8 @@ const deepEqual = function (p1, p2) {
                 return false;
             }
             cache.set(o1, true);
-            let keys1 = Object.keys(o1);
-            let keys2 = Object.keys(o2);
+            const keys1 = Object.keys(o1);
+            const keys2 = Object.keys(o2);
             if (keys1.length != keys2.length)
                 return false;
             keys1.sort();
@@ -49,8 +49,8 @@ const deepEqual = function (p1, p2) {
                 if (keys1[i] !== keys2[i]) {
                     return false;
                 }
-                let v1 = o1[keys1[i]];
-                let v2 = o2[keys1[i]];
+                const v1 = o1[keys1[i]];
+                const v2 = o2[keys1[i]];
                 if (!compare(v1, v2))
                     return false;
             }

package/package.json

@@ -1,7 +1,6 @@
 {
     "name": "@cleverbrush/deep",
-    "version": "0.0.2",
-    "type": "module",
+    "version": "0.0.3",
     "keywords": [
         "deep operations on objects",
         "deep equal",
@@ -10,6 +9,7 @@
     "author": "Andrew Zolotukhin <andrew_zol@cleverbrush.com>",
     "license": "BSD",
     "main": "./dist/index.js",
+    "readme": "https://github.com/cleverbrush/libs/tree/master/libs/deep#readme",
     "scripts": {
         "watch": "tsc --watch",
         "build": "tsc"

package/src/deepEqual.ts

@@ -2,7 +2,7 @@ const isBothNaN = function (v1, v2) {
     return Number.isNaN(v1) && Number.isNaN(v2);
 };
 
-const deepEqual = function (p1, p2) {
+const deepEqual = function (p1, p2): boolean {
     if (arguments.length !== 2) return false;
     const cache = new Map();
 
@@ -40,8 +40,8 @@ const deepEqual = function (p1, p2) {
 
             cache.set(o1, true);
 
-            let keys1 = Object.keys(o1);
-            let keys2 = Object.keys(o2);
+            const keys1 = Object.keys(o1);
+            const keys2 = Object.keys(o2);
             if (keys1.length != keys2.length) return false;
 
             keys1.sort();
@@ -51,8 +51,8 @@ const deepEqual = function (p1, p2) {
                     return false;
                 }
 
-                let v1 = o1[keys1[i]];
-                let v2 = o2[keys1[i]];
+                const v1 = o1[keys1[i]];
+                const v2 = o2[keys1[i]];
                 if (!compare(v1, v2)) return false;
             }
             return true;

package/tsconfig.json

@@ -3,10 +3,11 @@
         "rootDir": "./src",
         "outDir": "./dist",
         "declaration": true,
-        "target": "ES2020",
+        "target": "esnext",
         "module": "CommonJS",
         "esModuleInterop": true,
-        "moduleResolution": "Node"
+        "moduleResolution": "Node",
+        "allowSyntheticDefaultImports": true
     },
     "files": ["./src/index.ts"],
     "watchOptions": {