@rickard.antonsson/ts-utility 1.0.0 → 1.0.1

package/README.md

@@ -61,3 +61,49 @@ const result = groupBy(itemsWithSpecificGroups, item => item.group);
 // result now contains the grouped arrays.
 // typescript error occurs if you try to access result.noneexisting since its not in the group names
 ```
+
+## Other
+
+### Deep Partial Set
+
+As the name implies, sets an objects and subobjects properties.
+Optionally use a function to modify current value.
+
+```typescript
+it('should add 10 gold, 10 silver and 10 copper to persons pouch', () => {
+    const person = {
+      personal: {
+        firstName: 'Test',
+        lastName: 'Testsson',
+      },
+      items: {
+        pouch: {color: 'blue', contents: {gold: 10, silver: 20, copper: 30}},
+      },
+    };
+
+    const result = deepPartialSet(person, {
+      items: {
+        pouch: {
+          contents: {
+            gold: i => i + 10,
+            silver: i => i + 10,
+            copper: i => i + 10,
+          },
+        },
+      },
+    });
+
+    expect(result.items.pouch.contents).toEqual({
+      gold: 20,
+      silver: 30,
+      copper: 40,
+    });
+    // Keep unchanged objects
+    expect(result.personal).toBe(person.personal);
+    // New objects for the complete tree where a child has a change
+    expect(result).not.toBe(person);
+    expect(result.items).not.toBe(person.items);
+    expect(result.items.pouch).not.toBe(person.items.pouch);
+    expect(result.items.pouch.contents).not.toBe(person.items.pouch.contents);
+  });
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rickard.antonsson/ts-utility",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",