🤖 Merge PR DefinitelyTyped#46539 clone 2.1.2: Fixed missing parameters and overload. by @DG-za

* Fixed clone method missing parameters and overload.

* Update types/clone/index.d.ts

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <[email protected]>

* Update types/clone/index.d.ts

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <[email protected]>

* Update index.d.ts

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <[email protected]>

Author: DG-za

types/clone/clone-tests.ts

@@ -1,11 +1,20 @@
+import clone = require('clone');
 
-import clone = require("clone");
-
-var original = {
-    key: "value"
+const original = {
+    key: 'value',
 };
 
-var copy = clone(original);
+let copy = clone(original);
+
 copy = clone(original, false);
 copy = clone(original, true, 1);
+copy = clone(original, true, 1, {});
+copy = clone(original, true, 1, {}, true);
+
+copy = clone(original, {});
+copy = clone(original, { circular: false });
+copy = clone(original, { circular: true, depth: 1 });
+copy = clone(original, { circular: true, depth: 2, prototype: {} });
+copy = clone(original, { circular: true, depth: 3, prototype: {}, includeNonEnumerable: true });
+
 copy = clone.clonePrototype(original);

types/clone/index.d.ts

@@ -1,6 +1,7 @@
-// Type definitions for clone 0.1.11
+// Type definitions for clone 2.1
 // Project: https://github.com/pvorb/node-clone
-// Definitions by: Kieran Simpson <https://github.com/kierans/DefinitelyTyped>
+// Definitions by: Kieran Simpson <https://github.com/kierans>
+//                 DG-za <https://github.com/DG-za>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 /**
@@ -10,9 +11,28 @@
 /**
  * @param val the value that you want to clone, any type allowed
  * @param circular Call clone with circular set to false if you are certain that obj contains no circular references. This will give better performance if needed. There is no error if undefined or null is passed as obj.
- * @param depth to wich the object is to be cloned (optional, defaults to infinity)
+ * @param depth to which the object is to be cloned (optional, defaults to infinity)
+ * @param prototype Sets the prototype to be used when cloning an Object (optional, defaults to __proto__)
+ * @param includeNonEnumerable Set to true if the non-enumerable properties should be cloned as well (optional, defaults to false)
  */
-declare function clone<T>(val: T, circular?: boolean, depth?: number): T;
+declare function clone<T>(val: T, circular?: boolean, depth?: number, prototype?: any, includeNonEnumerable?: boolean): T;
+
+/**
+ * @param val the value that you want to clone, any type allowed
+ * @param opts a single object that specifies circular, depth, prototype and includeNonEnumerable.
+ * @param opts.circular Call clone with circular set to false if you are certain that obj contains no circular references. This will give better performance if needed. There is no error if undefined or null is passed as obj.
+ * @param opts.depth Sets depth to which the object is to be cloned (optional, defaults to infinity)
+ * @param opts.prototype Sets the prototype to be used when cloning an Object (optional, defaults to __proto__)
+ * @param opts.includeNonEnumerable Set to true if the non-enumerable properties should be cloned as well (optional, defaults to false)
+ */
+declare function clone<T>(val: T, opts: CloneOpts): T;
+
+interface CloneOpts {
+    circular?: boolean,
+    depth?: number,
+    prototype?: any,
+    includeNonEnumerable?: boolean
+}
 
 declare namespace clone {
     /**