docs for .withOptions

README.md

@@ -7,6 +7,8 @@
 
 Cross-runtime deep object merging in JavaScript environments, including Deno, Bun, Node.js and Browser. It is designed to handle complex data structures, including arrays, Maps, Sets, and primitive values. It provides flexible customization options for handling array, Set, and Map merging strategies.
 
+Follow the library on [JSR.io](https://jsr.io/@cross/deepmerge)
+
 ## Features
 
 * **Cross-Runtime Compatibility:**

jsr.jsonc

@@ -1,5 +1,5 @@
 {
     "name": "@cross/deepmerge",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "exports": "./mod.ts"
 }

mod.ts

@@ -87,6 +87,15 @@ function isObject(item: unknown): item is MergeableObject {
  * Performs a deep merge of objects, handling arrays, Maps, Sets, and primitives.
  * Supports multiple source objects.
  *
+ * **Customizing Behavior with the attached `deepMerge.withOptions()` method** 
+ * `.withOptions()` allows you to create a modified version of `deepMerge` with
+ * pre-configured merge behavior. For instance:
+ *
+ * ```javascript
+ * const combineUniqueArrays = deepMerge.withOptions({ arrayMergeStrategy: 'unique' });
+ * const combined = combineUniqueArrays({ arr: [1, 2] }, { arr: [2, 3] }); // combined.arr = [1, 2, 3]
+ * ```
+ * 
  * @template T
  * @param {T} target - The base object to merge into.
  * @param {...T} sources - One or more source objects to merge.