deepie-merge 1.0.0 → 1.1.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 array 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/index.js

@@ -1,11 +1,8 @@
 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 extendArrays(a, b) {
-  return uniq([...a, ...b]);
-}
-
-function type(obj) {
+function getType(obj) {
   if (isObject(obj)) return "object";
   if (Array.isArray(obj)) return "array";
   return typeof obj;
@@ -16,14 +13,14 @@ function canExtendArray(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} = {}) {
+export function deepMerge(a, b, {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 = type(a[key]);
-    const typeB = type(b[key]);
+    const typeA = getType(a[key]);
+    const typeB = getType(b[key]);
     if (typeA !== typeB) { // different type, overwrite
       a[key] = b[key];
     } else { // same type

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "deepie-merge",
-  "version": "1.0.0",
-  "description": "Yet another deep merge",
+  "version": "1.1.0",
+  "description": "Yay, another deep merge",
   "author": "silverwind <me@silverwind.io>",
   "repository": "silverwind/deepie-merge",
   "license": "BSD-2-Clause",
@@ -16,10 +16,10 @@
   ],
   "devDependencies": {
     "eslint": "8.57.0",
-    "eslint-config-silverwind": "80.0.5",
-    "updates": "15.1.2",
+    "eslint-config-silverwind": "82.0.3",
+    "updates": "15.3.1",
     "versions": "12.0.1",
     "vitest": "1.3.1",
-    "vitest-config-silverwind": "5.1.1"
+    "vitest-config-silverwind": "5.1.2"
   }
 }