bunshin-clone 1.0.11 → 1.0.13

package/README.md

@@ -1,6 +1,6 @@
 # Bunshin Clone
 
-High-performance deep clone utility with descriptor support. Supports circular references and complex built-in types.
+High-performance deep clone utility with descriptor support. Handles circular ref and complex built-in types.
 
 * Fast (no unnecessary overhead)
 * Deep clone (no structural sharing)
@@ -20,39 +20,30 @@ npm i bunshin-clone
 // npm
 import bunshinClone from 'bunshin-clone';
 
-// CDN
+// CDNs
+import bunshinClone from 'https://esm.sh/bunshin-clone'
+// or
 import bunshinClone from 'https://cdn.jsdelivr.net/npm/bunshin-clone/+esm';
+// or
+import bunshinClone from 'https://unpkg.com/bunshin-clone/dist/index.js';
 ```
 
 ## Usage
 
 ```ts
-import bunshinClone from 'bunshin-clone';
-
-const source = { foo: 1, nested: { x: 1 } };
-
-const result = bunshinClone(source);
-
-console.log(result);
-// { foo: 1, nested: { x: 1 } }
-
-console.log(result === source); // false
-console.log(result.nested === source.nested); // false
-```
-
-## API
-
-```ts
-bunshinClone(target)
-bunshinClone(target, options)
+bunshinClone(source, options);
+// => T
+//
+// source: T
+// options (optional): BunshinCloneOptions
 ```
 
-## Options
+### 🪄 Options
 
 ```ts
-BunshinCloneOptions {
-  preserveDescriptors: false;
-  strictDescriptors: false;
+interface BunshinCloneOptions {
+  preserveDescriptors?: boolean; // (default: false)
+  strictDescriptors?: boolean;   // (default: false)
 }
 ```
 
@@ -96,6 +87,20 @@ bunshinClone(obj, { strictDescriptors: true });
 
 ---
 
+## Example
+
+```ts
+const source = { foo: 1, nested: { x: 1 } };
+
+const result = bunshinClone(source);
+
+console.log(result);
+// { foo: 1, nested: { x: 1 } }
+
+console.log(result === source); // false
+console.log(result.nested === source.nested); // false
+```
+
 ## Supported Types
 
 bunshin-clone correctly handles:

package/dist/index.cjs

@@ -6,89 +6,89 @@ var { hasOwnProperty: HAS_OWN } = Object.prototype;
 function bunshinClone(source, options) {
   return clone(source, options ?? EMPTY_OPTIONS, /* @__PURE__ */ new WeakMap());
 }
-function clone(node, options, ref) {
+function clone(node, options, refs) {
   if (!isObject(node)) {
     return node;
   }
-  const cached = ref.get(node);
-  if (cached !== void 0) {
-    return cached;
+  const ref = refs.get(node);
+  if (ref !== void 0) {
+    return ref;
   }
   if (options.preserveDescriptors && isPlainObject(node)) {
-    return cloneWithDescriptors(node, options, ref);
+    return cloneWithDescriptors(node, options, refs);
   }
   if (Array.isArray(node)) {
     const result = [];
-    ref.set(node, result);
+    refs.set(node, result);
     for (let i = 0, l = node.length; i < l; i++) {
-      result[i] = clone(node[i], options, ref);
+      result[i] = clone(node[i], options, refs);
     }
     return result;
   }
   if (isPlainObject(node)) {
     const result = Object.create(Object.getPrototypeOf(node));
-    ref.set(node, result);
+    refs.set(node, result);
     for (const key in node) {
       if (!HAS_OWN.call(node, key) || isUnsafeKey(key)) {
         continue;
       }
-      result[key] = clone(node[key], options, ref);
+      result[key] = clone(node[key], options, refs);
     }
     return result;
   }
   if (node instanceof Map) {
     const result = /* @__PURE__ */ new Map();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const [key, value] of node) {
-      result.set(clone(key, options, ref), clone(value, options, ref));
+      result.set(clone(key, options, refs), clone(value, options, refs));
     }
     return result;
   }
   if (node instanceof Set) {
     const result = /* @__PURE__ */ new Set();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const item of node) {
-      result.add(clone(item, options, ref));
+      result.add(clone(item, options, refs));
     }
     return result;
   }
   if (node instanceof Date) {
     const result = new Date(node.getTime());
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (node instanceof RegExp) {
     const result = new RegExp(node.source, node.flags);
-    ref.set(node, result);
+    refs.set(node, result);
     result.lastIndex = node.lastIndex;
     return result;
   }
   if (node instanceof ArrayBuffer) {
     const result = node.slice(0);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (ArrayBuffer.isView(node)) {
     const { buffer, byteOffset, byteLength } = node;
     if (node instanceof DataView) {
       const result = new DataView(buffer.slice(0), byteOffset, byteLength);
-      ref.set(node, result);
+      refs.set(node, result);
       return result;
     } else {
       const Ctor = node.constructor;
       const result = new Ctor(
         buffer.slice(byteOffset, byteOffset + byteLength)
       );
-      ref.set(node, result);
+      refs.set(node, result);
       return result;
     }
   }
   if (node instanceof Error || typeof DOMException !== "undefined" && node instanceof DOMException) {
-    return cloneError(node, options, ref);
+    return cloneError(node, options, refs);
   }
   if (typeof Blob !== "undefined" && node instanceof Blob) {
     const result = node.slice(0, node.size, node.type);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof ImageData !== "undefined" && node instanceof ImageData) {
@@ -97,29 +97,29 @@ function clone(node, options, ref) {
       node.width,
       node.height
     );
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof URL !== "undefined" && node instanceof URL) {
     const result = new URL(node.href);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof URLSearchParams !== "undefined" && node instanceof URLSearchParams) {
     const result = new URLSearchParams();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const [key, value] of node) {
       result.append(key, value);
     }
     return result;
   }
-  ref.set(node, node);
+  refs.set(node, node);
   return node;
 }
-function cloneError(value, options, ref) {
+function cloneError(value, options, refs) {
   if (value instanceof DOMException) {
     const result2 = new DOMException(value.message, value.name);
-    ref.set(value, result2);
+    refs.set(value, result2);
     return result2;
   }
   const name = value.name || "Error";
@@ -148,7 +148,7 @@ function cloneError(value, options, ref) {
       result = new Error(message);
       result.name = name;
   }
-  ref.set(value, result);
+  refs.set(value, result);
   if (value.stack) {
     try {
       result.stack = value.stack;
@@ -156,16 +156,16 @@ function cloneError(value, options, ref) {
     }
   }
   if ("cause" in value && value.cause !== void 0) {
-    result.cause = clone(value.cause, options, ref);
+    result.cause = clone(value.cause, options, refs);
   }
   for (const key of Object.keys(value)) {
-    result[key] = clone(value[key], options, ref);
+    result[key] = clone(value[key], options, refs);
   }
   return result;
 }
-function cloneWithDescriptors(node, options, ref) {
+function cloneWithDescriptors(node, options, refs) {
   const result = Object.create(Object.getPrototypeOf(node));
-  ref.set(node, result);
+  refs.set(node, result);
   const descs = Object.getOwnPropertyDescriptors(node);
   forEachOwnKey(descs, (key) => {
     if (isUnsafeKey(key)) {
@@ -173,7 +173,7 @@ function cloneWithDescriptors(node, options, ref) {
     }
     const desc = { ...descs[key] };
     if ("value" in desc) {
-      desc.value = clone(desc.value, options, ref);
+      desc.value = clone(desc.value, options, refs);
     }
     try {
       Object.defineProperty(result, key, desc);
@@ -185,13 +185,13 @@ function cloneWithDescriptors(node, options, ref) {
   });
   return result;
 }
-function forEachOwnKey(object, callback) {
+function forEachOwnKey(object, fn) {
   for (const key of Object.keys(object)) {
-    callback(key);
+    fn(key);
   }
   const symbols = Object.getOwnPropertySymbols(object);
   for (let i = 0, l = symbols.length; i < l; i++) {
-    callback(symbols[i]);
+    fn(symbols[i]);
   }
 }
 function isObject(value) {
@@ -210,9 +210,9 @@ function isUnsafeKey(key) {
 /**
  * Bunshin Clone
  * High-performance deep clone utility with descriptor support.
- * Supports circular ref and complex built-in types.
+ * Handles circular ref and complex built-in types.
  *
- * @version 1.0.11
+ * @version 1.0.13
  * @author Yusuke Kamiyamane
  * @license MIT
  * @copyright Copyright (c) 2026 Yusuke Kamiyamane

package/dist/index.d.cts

@@ -1,9 +1,9 @@
 /**
  * Bunshin Clone
  * High-performance deep clone utility with descriptor support.
- * Supports circular ref and complex built-in types.
+ * Handles circular ref and complex built-in types.
  *
- * @version 1.0.11
+ * @version 1.0.13
  * @author Yusuke Kamiyamane
  * @license MIT
  * @copyright Copyright (c) 2026 Yusuke Kamiyamane

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Bunshin Clone
  * High-performance deep clone utility with descriptor support.
- * Supports circular ref and complex built-in types.
+ * Handles circular ref and complex built-in types.
  *
- * @version 1.0.11
+ * @version 1.0.13
  * @author Yusuke Kamiyamane
  * @license MIT
  * @copyright Copyright (c) 2026 Yusuke Kamiyamane

package/dist/index.js

@@ -4,89 +4,89 @@ var { hasOwnProperty: HAS_OWN } = Object.prototype;
 function bunshinClone(source, options) {
   return clone(source, options ?? EMPTY_OPTIONS, /* @__PURE__ */ new WeakMap());
 }
-function clone(node, options, ref) {
+function clone(node, options, refs) {
   if (!isObject(node)) {
     return node;
   }
-  const cached = ref.get(node);
-  if (cached !== void 0) {
-    return cached;
+  const ref = refs.get(node);
+  if (ref !== void 0) {
+    return ref;
   }
   if (options.preserveDescriptors && isPlainObject(node)) {
-    return cloneWithDescriptors(node, options, ref);
+    return cloneWithDescriptors(node, options, refs);
   }
   if (Array.isArray(node)) {
     const result = [];
-    ref.set(node, result);
+    refs.set(node, result);
     for (let i = 0, l = node.length; i < l; i++) {
-      result[i] = clone(node[i], options, ref);
+      result[i] = clone(node[i], options, refs);
     }
     return result;
   }
   if (isPlainObject(node)) {
     const result = Object.create(Object.getPrototypeOf(node));
-    ref.set(node, result);
+    refs.set(node, result);
     for (const key in node) {
       if (!HAS_OWN.call(node, key) || isUnsafeKey(key)) {
         continue;
       }
-      result[key] = clone(node[key], options, ref);
+      result[key] = clone(node[key], options, refs);
     }
     return result;
   }
   if (node instanceof Map) {
     const result = /* @__PURE__ */ new Map();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const [key, value] of node) {
-      result.set(clone(key, options, ref), clone(value, options, ref));
+      result.set(clone(key, options, refs), clone(value, options, refs));
     }
     return result;
   }
   if (node instanceof Set) {
     const result = /* @__PURE__ */ new Set();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const item of node) {
-      result.add(clone(item, options, ref));
+      result.add(clone(item, options, refs));
     }
     return result;
   }
   if (node instanceof Date) {
     const result = new Date(node.getTime());
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (node instanceof RegExp) {
     const result = new RegExp(node.source, node.flags);
-    ref.set(node, result);
+    refs.set(node, result);
     result.lastIndex = node.lastIndex;
     return result;
   }
   if (node instanceof ArrayBuffer) {
     const result = node.slice(0);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (ArrayBuffer.isView(node)) {
     const { buffer, byteOffset, byteLength } = node;
     if (node instanceof DataView) {
       const result = new DataView(buffer.slice(0), byteOffset, byteLength);
-      ref.set(node, result);
+      refs.set(node, result);
       return result;
     } else {
       const Ctor = node.constructor;
       const result = new Ctor(
         buffer.slice(byteOffset, byteOffset + byteLength)
       );
-      ref.set(node, result);
+      refs.set(node, result);
       return result;
     }
   }
   if (node instanceof Error || typeof DOMException !== "undefined" && node instanceof DOMException) {
-    return cloneError(node, options, ref);
+    return cloneError(node, options, refs);
   }
   if (typeof Blob !== "undefined" && node instanceof Blob) {
     const result = node.slice(0, node.size, node.type);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof ImageData !== "undefined" && node instanceof ImageData) {
@@ -95,29 +95,29 @@ function clone(node, options, ref) {
       node.width,
       node.height
     );
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof URL !== "undefined" && node instanceof URL) {
     const result = new URL(node.href);
-    ref.set(node, result);
+    refs.set(node, result);
     return result;
   }
   if (typeof URLSearchParams !== "undefined" && node instanceof URLSearchParams) {
     const result = new URLSearchParams();
-    ref.set(node, result);
+    refs.set(node, result);
     for (const [key, value] of node) {
       result.append(key, value);
     }
     return result;
   }
-  ref.set(node, node);
+  refs.set(node, node);
   return node;
 }
-function cloneError(value, options, ref) {
+function cloneError(value, options, refs) {
   if (value instanceof DOMException) {
     const result2 = new DOMException(value.message, value.name);
-    ref.set(value, result2);
+    refs.set(value, result2);
     return result2;
   }
   const name = value.name || "Error";
@@ -146,7 +146,7 @@ function cloneError(value, options, ref) {
       result = new Error(message);
       result.name = name;
   }
-  ref.set(value, result);
+  refs.set(value, result);
   if (value.stack) {
     try {
       result.stack = value.stack;
@@ -154,16 +154,16 @@ function cloneError(value, options, ref) {
     }
   }
   if ("cause" in value && value.cause !== void 0) {
-    result.cause = clone(value.cause, options, ref);
+    result.cause = clone(value.cause, options, refs);
   }
   for (const key of Object.keys(value)) {
-    result[key] = clone(value[key], options, ref);
+    result[key] = clone(value[key], options, refs);
   }
   return result;
 }
-function cloneWithDescriptors(node, options, ref) {
+function cloneWithDescriptors(node, options, refs) {
   const result = Object.create(Object.getPrototypeOf(node));
-  ref.set(node, result);
+  refs.set(node, result);
   const descs = Object.getOwnPropertyDescriptors(node);
   forEachOwnKey(descs, (key) => {
     if (isUnsafeKey(key)) {
@@ -171,7 +171,7 @@ function cloneWithDescriptors(node, options, ref) {
     }
     const desc = { ...descs[key] };
     if ("value" in desc) {
-      desc.value = clone(desc.value, options, ref);
+      desc.value = clone(desc.value, options, refs);
     }
     try {
       Object.defineProperty(result, key, desc);
@@ -183,13 +183,13 @@ function cloneWithDescriptors(node, options, ref) {
   });
   return result;
 }
-function forEachOwnKey(object, callback) {
+function forEachOwnKey(object, fn) {
   for (const key of Object.keys(object)) {
-    callback(key);
+    fn(key);
   }
   const symbols = Object.getOwnPropertySymbols(object);
   for (let i = 0, l = symbols.length; i < l; i++) {
-    callback(symbols[i]);
+    fn(symbols[i]);
   }
 }
 function isObject(value) {
@@ -208,9 +208,9 @@ function isUnsafeKey(key) {
 /**
  * Bunshin Clone
  * High-performance deep clone utility with descriptor support.
- * Supports circular ref and complex built-in types.
+ * Handles circular ref and complex built-in types.
  *
- * @version 1.0.11
+ * @version 1.0.13
  * @author Yusuke Kamiyamane
  * @license MIT
  * @copyright Copyright (c) 2026 Yusuke Kamiyamane

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunshin-clone",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "High-performance deep clone utility with descriptor support",
   "type": "module",
   "main": "./dist/index.cjs",