@cleverbrush/deep 0.0.1 → 0.0.4

package/README.md

@@ -0,0 +1,61 @@
+# Deep operations 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

@@ -11,8 +11,8 @@ const deepEqual = function (p1, p2) {
         const arraysAreIdentical = function (a1, a2) {
             if (a1.length !== a2.length)
                 return false;
-            const c1 = a1.map(t => t).sort();
-            const c2 = a2.map(t => t).sort();
+            const c1 = a1.map((t) => t).sort();
+            const c2 = a2.map((t) => t).sort();
             for (let i = 0; i < c1.length; i++) {
                 if (!compare(c1[i], c2[i]))
                     return false;
@@ -27,7 +27,8 @@ const deepEqual = function (p1, p2) {
             return false;
         if (isBothNaN(o1, o2))
             return true;
-        if ((Array.isArray(o1) && !Array.isArray(o2)) || (!Array.isArray(o1) && Array.isArray(o2))) {
+        if ((Array.isArray(o1) && !Array.isArray(o2)) ||
+            (!Array.isArray(o1) && Array.isArray(o2))) {
             return false;
         }
         if (Array.isArray(o1) && Array.isArray(o2)) {
@@ -38,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();
@@ -48,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/dist/deepExtend.js

@@ -14,7 +14,9 @@ const deepExtend = function () {
         const keys = Object.keys(o2);
         for (let i = 0; i < keys.length; i++) {
             if (o2.hasOwnProperty(keys[i])) {
-                if ((!o1.hasOwnProperty(keys[i])) || !(typeof o1[keys[i]] === 'object' && typeof o2[keys[i]] === 'object')) {
+                if (!o1.hasOwnProperty(keys[i]) ||
+                    !(typeof o1[keys[i]] === 'object' &&
+                        typeof o2[keys[i]] === 'object')) {
                     o1[keys[i]] = o2[keys[i]];
                 }
                 else {

package/dist/index.d.ts

@@ -1,3 +1,8 @@
 import deepEqual from './deepEqual';
 import deepExtend from './deepExtend';
 export { deepEqual, deepExtend };
+declare const _default: {
+    deepEqual: (p1: any, p2: any) => boolean;
+    deepExtend: (...args: any) => any;
+};
+export default _default;

package/dist/index.js

@@ -8,3 +8,7 @@ const deepEqual_1 = __importDefault(require("./deepEqual"));
 exports.deepEqual = deepEqual_1.default;
 const deepExtend_1 = __importDefault(require("./deepExtend"));
 exports.deepExtend = deepExtend_1.default;
+exports.default = {
+    deepEqual: deepEqual_1.default,
+    deepExtend: deepExtend_1.default
+};

package/package.json

@@ -1,7 +1,6 @@
 {
     "name": "@cleverbrush/deep",
-    "version": "0.0.1",
-    "type": "module",
+    "version": "0.0.4",
     "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/src/index.ts

@@ -2,3 +2,8 @@ import deepEqual from './deepEqual';
 import deepExtend from './deepExtend';
 
 export { deepEqual, deepExtend };
+
+export default {
+    deepEqual,
+    deepExtend
+};

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": {