👨‍🔧 Open Patcher

A community library for patching JavaScript objects.

Make changes to objects using JSON paths 😎

Note: If you have any ideas, bug fixes, or feature requests, please feel free to open an issue or submit a pull request on our GitHub repository. Your contributions will be greatly appreciated! 🤝

API Documentation

applyPatch({source, operations})

Applies a patch (an array of operations) to the given object and returns the patched object.

Named Parameters

• source (Object): The object to be patched.
• operations (Array): An array of operations.

Returns

• (Object): The patched object.

Example

1import openPatcher from 'open-patcher';
2
3const source = {
4  name: 'John',
5  age: 30,
6  address: {
7    city: 'New York',
8    country: 'USA',
9  },
10  hobbies: [
11    { name: 'Reading', type: 'Indoor' },
12    { name: 'Hiking', type: 'Outdoor' },
13  ],
14};
15
16const operations = [
17  { type: 'add', path: '/name', value: 'Jane' },
18  { type: 'replace', path: '/age', value: 35 },
19  { type: 'remove', path: '/address/country' },
20  {
21    type: 'add',
22    path: '/hobbies/1',
23    value: { name: 'Swimming', type: 'Outdoor' },
24  },
25  { type: 'replace', path: '/hobbies/0/type', value: 'Indoor/Outdoor' },
26  { type: 'remove', path: '/hobbies/1' },
27];
28
29const patchedObj = openPatcher.applyPatch({ source, operations });
30
31console.log(patchedObj);
32
33/* Output:
34{
35  "name": "Jane",
36  "age": 35,
37  "address": {
38    "city": "New York"
39  },
40  "hobbies": [
41    { "name": "Reading", "type": "Indoor/Outdoor" }
42  ]
43}
44*/

applyOperation({source, operation})

Applies a single patch operation to a source object or array.

Named Parameters

• source: The source object or array to be patched. This can be any JavaScript object or array.
• operation: The patch operation to apply. This should be an object that represents a patch operation. The exact structure of this object depends on the type of operation.

Returns

(Object): The patched object.

Example

1import openPatcher from 'open-patcher';
2
3const source = [1, 2, 3];
4const operation = { type: 'add', path: '/1', value: 4 };
5const patchedObj = openPatcher.applyOperation({ source, operation });
6console.log(patchedObj);
7/* Output:
8[1, 4, 2, 3]
9*/

applyArrayPatch({source, operations, options})

Applies a batch of operations to an array and returns the modified array.

Parameters

• source: The original array to be patched. This can be any JavaScript array.
• operations: The array of operations to apply. Each operation should be an object that represents a patch operation. The exact structure of this object depends on the type of operation.
• options (optional): An object with the following properties:
  • chainOperations (optional, default = false): A boolean that determines whether operations should be chained. If true, operations are applied in the order they appear in the operations array. If false or not provided, operations are sorted and applied in descending order to avoid index shifting during deletion.
  • mutateSource (optional, default = false): A boolean that determines whether the source array should be mutated. If true, the source array is modified in-place. If false or not provided, a new array is created and modified.

Returns

The updated source array after applying the patch operations. If options.mutateSource is true, this will be the same array as source. Otherwise, it will be a new array.

Example

1const source = [1, 2, 3];
2const operations = [{ type: 'add', index: 1, value: 4 }];
3const options = { chainOperations: false, mutateSource: false };
4applyArrayPatch({ source, operations, options });
5// returns [1, 4, 2, 3]

Notes

The returned patched object is a shallow clone of the source object. This means that only the affected nodes are cloned and modified, while non-affected nodes share references with the source object. Any mutations made to the patchedObj will also affect the source object. To avoid this, it is recommended to deeply clone the patchedObj before making any mutations.

Contributing

We welcome contributions from the developer community to enhance the functionality and usability of this library. If you have any ideas, bug fixes, or feature requests, please feel free to open an issue or submit a pull request on our GitHub repository. Your contributions will be greatly appreciated!