deepie-merge 1.0.0 → 1.2.0

package/README.md

@@ -1,7 +1,7 @@
 # deepie-merge
 [![](https://img.shields.io/npm/v/deepie-merge.svg?style=flat)](https://www.npmjs.org/package/deepie-merge) [![](https://img.shields.io/npm/dm/deepie-merge.svg)](https://www.npmjs.org/package/deepie-merge) [![](https://packagephobia.com/badge?p=deepie-merge)](https://packagephobia.com/result?p=deepie-merge)
 
-> Yet another deep merge
+> Yay, another deep merge
 
 ## Usage
 ```console
@@ -12,10 +12,23 @@ npm i deepie-merge
 import {deepMerge} from "deepie-merge";
 
 deepMerge({a: [1]}, {a: [2]});
-// => {a: [1]}
+// => {a: [2]}
 
 deepMerge({a: [1]}, {a: [2]}, {arrayExtend: true});
 // => {a: [1, 2]}
+
+deepMerge({a: [1], b: [1]}, {a: [2], b: [2]}, {arrayExtend: ["a"]});
+// => {a: [1, 2], b: [2]}
 ```
 
+## API
+
+### deepMerge(dst, src, options)
+
+- `dst` *any*: Destination value
+- `src` *any*: Source value
+- `options` *object*:
+  - `arrayExtend` *boolean* or *string[]*: Whether to extend arrays instead of replacing them. When passed a string array, it will only extend the object keys provided in that array.
+  - `maxRecursions` *number*: Amount of nesting levels to recurse into. Default: `10`
+
 © [silverwind](https://github.com/silverwind), distributed under BSD licence

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+type ArrayExtend = boolean | string[];
+type DeepieMergeOpts = {
+    /** Either a boolean or a array of property keys to allow extension. */
+    arrayExtend: ArrayExtend;
+    /** Maximum recursions to perform. Default: 10. */
+    maxRecursion?: number;
+};
+export declare function deepMerge(a: any, b: any, { arrayExtend, maxRecursion }?: DeepieMergeOpts): any;
+export {};

package/dist/index.js

@@ -0,0 +1,40 @@
+const isObject = (obj) => Object.prototype.toString.call(obj) === "[object Object]";
+const uniq = (arr) => Array.from(new Set(arr));
+const extendArrays = (a, b) => uniq([...a, ...b]);
+function getType(obj) {
+  if (isObject(obj))
+    return "object";
+  if (Array.isArray(obj))
+    return "array";
+  return typeof obj;
+}
+function canExtendArray(key, arrayExtend) {
+  return Array.isArray(arrayExtend) ? arrayExtend.includes(key) : arrayExtend;
+}
+function deepMerge(a, b, { arrayExtend = false, maxRecursion = 10 } = { arrayExtend: false, maxRecursion: 10 }) {
+  if (Array.isArray(a) && Array.isArray(b))
+    return arrayExtend ? extendArrays(a, b) : b;
+  if (!isObject(b))
+    return b;
+  if (maxRecursion === 0)
+    return a;
+  for (const key of Object.keys(b)) {
+    const typeA = getType(a[key]);
+    const typeB = getType(b[key]);
+    if (typeA !== typeB) {
+      a[key] = b[key];
+    } else {
+      if (typeA === "array" && canExtendArray(key, arrayExtend)) {
+        a[key] = extendArrays(a[key], b[key]);
+      } else if (typeA === "object") {
+        a[key] = deepMerge(a[key], b[key], { arrayExtend, maxRecursion: maxRecursion - 1 });
+      } else {
+        a[key] = b[key];
+      }
+    }
+  }
+  return a;
+}
+export {
+  deepMerge
+};

package/package.json

@@ -1,25 +1,32 @@
 {
   "name": "deepie-merge",
-  "version": "1.0.0",
-  "description": "Yet another deep merge",
+  "version": "1.2.0",
+  "description": "Yay, another deep merge",
   "author": "silverwind <me@silverwind.io>",
   "repository": "silverwind/deepie-merge",
   "license": "BSD-2-Clause",
-  "exports": "./index.js",
   "type": "module",
   "sideEffects": false,
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "engines": {
     "node": ">=18"
   },
-  "files": [
-    "index.js"
-  ],
   "devDependencies": {
+    "@types/node": "20.12.8",
     "eslint": "8.57.0",
-    "eslint-config-silverwind": "80.0.5",
-    "updates": "15.1.2",
+    "eslint-config-silverwind": "84.0.0",
+    "eslint-config-silverwind-typescript": "3.2.3",
+    "typescript": "5.4.5",
+    "typescript-config-silverwind": "4.0.1",
+    "updates": "16.0.1",
     "versions": "12.0.1",
-    "vitest": "1.3.1",
-    "vitest-config-silverwind": "5.1.1"
+    "vite": "5.2.11",
+    "vite-plugin-dts": "3.9.0",
+    "vitest": "1.5.3",
+    "vitest-config-silverwind": "9.0.4"
   }
 }

package/index.js

@@ -1,41 +0,0 @@
-const isObject = obj => Object.prototype.toString.call(obj) === "[object Object]";
-const uniq = arr => Array.from(new Set(arr));
-
-function extendArrays(a, b) {
-  return uniq([...a, ...b]);
-}
-
-function type(obj) {
-  if (isObject(obj)) return "object";
-  if (Array.isArray(obj)) return "array";
-  return typeof obj;
-}
-
-function canExtendArray(key, arrayExtend) {
-  return Array.isArray(arrayExtend) ? arrayExtend.includes(key) : arrayExtend;
-}
-
-// merge b int a, arrayExtend is either a boolean or a array of property keys to allow extension
-export function deepMerge(a, b, {maxRecursion = 10, arrayExtend = false} = {}) {
-  if (Array.isArray(a) && Array.isArray(b)) return arrayExtend ? extendArrays(a, b) : b;
-  if (!isObject(b)) return b;
-  if (maxRecursion === 0) return a;
-
-  for (const key of Object.keys(b)) {
-    const typeA = type(a[key]);
-    const typeB = type(b[key]);
-    if (typeA !== typeB) { // different type, overwrite
-      a[key] = b[key];
-    } else { // same type
-      if (typeA === "array" && canExtendArray(key, arrayExtend)) {
-        a[key] = extendArrays(a[key], b[key]);
-      } else if (typeA === "object") {
-        a[key] = deepMerge(a[key], b[key], {arrayExtend, maxRecursion: maxRecursion - 1});
-      } else {
-        a[key] = b[key];
-      }
-    }
-  }
-
-  return a;
-}