Finetune the types

trojs · Oct 10, 2024 · 3be4365 · 3be4365
1 parent 6a686bf
commit 3be4365
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 83 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@trojs/deep-merge",
     "description": "Object deep merge",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
@@ -59,4 +59,4 @@
         "type": "github",
         "url": "https://github.com/sponsors/w3nl"
     }
-}
+}
diff --git a/src/deep-merge.js b/src/deep-merge.js
@@ -1,7 +1,8 @@
 /**
- * Deep merge objects
- * @param {any} objects - Objects to merge
- * @returns {object} New object with merged key/values
+ * Deeply merges multiple objects into one.
+ * @template {object} [T=object]
+ * @param {...any} objects - Objects to merge
+ * @returns {T} New object with merged key/values
  */
 export const deepMerge = (...objects) => {
     const isObject = (obj) => obj?.constructor === Object;

diff --git a/src/schema.d.ts b/src/schema.d.ts
@@ -1,3 +1,8 @@
-export function deepMerge(
-    ...objects: object[]
-): object;
+/**
+ * @template {object} [T=object]
+ * @param {...any} objects - Objects to merge
+ * @returns {T} New object with merged key/values
+ */
+export function deepMerge<T extends object = object>(
+    ...objects: any[]
+): T;