bunshin-clone 1.0.11 → 1.0.12

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

@@ -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.12
  * @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.12
  * @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.12
  * @author Yusuke Kamiyamane
  * @license MIT
  * @copyright Copyright (c) 2026 Yusuke Kamiyamane

package/dist/index.js

@@ -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.12
  * @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.12",
   "description": "High-performance deep clone utility with descriptor support",
   "type": "module",
   "main": "./dist/index.cjs",