https://github.com/pomgui/deep
Ultrasmall footprint -- lodash.merge compatible, JSON diff & patch utilities
https://github.com/pomgui/deep
json-diff json-patch merge
Last synced: 6 days ago
JSON representation
Ultrasmall footprint -- lodash.merge compatible, JSON diff & patch utilities
- Host: GitHub
- URL: https://github.com/pomgui/deep
- Owner: pomgui
- License: other
- Created: 2022-04-13T12:22:55.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-09-13T00:53:46.000Z (7 months ago)
- Last Synced: 2025-09-13T02:42:15.597Z (7 months ago)
- Topics: json-diff, json-patch, merge
- Language: JavaScript
- Homepage:
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deep
Ultra small footprint merge & freeze methods.
### deepMerge
This method is like `assign` except that it recursively merges own and
inherited enumerable string keyed properties of source objects into the
destination object. Source properties that resolve to `undefined` are
skipped if a destination value exists. Array and plain object properties
are merged recursively. Other objects and value types are overridden by
assignment. Source objects are applied from left to right. Subsequent
sources overwrite property assignments of previous sources.
For the most cases it is compatible with
[lodash.merge](https://www.npmjs.com/package/lodash.merge) package.
### deepFreeze
This method executes an recursive Object.freeze.
### diff
Compares two JSON objects and returns the delta (difference), optimizing bandwidth usage—ideal for PATCH requests in REST services.
### patch
Takes the diff's result and applies it into a JSON object, reconstructing the most recent version.
## Installation
Using npm:
```bash
$ {sudo -H} npm i -g npm
$ npm i --save @pomgui/deep
```
In Node.js:
```js
var { deepMerge } = require('@pomgui/deep');
```
With typescript:
```typescript
import { deepMerge } from '@pomgui/deep';
import { diff, patch } from '@pomgui/deep';
```
## Usage
### deepMerge
```js
const object = {
'a': [{ 'b': 2 }, { 'd': 4 }]
}
const other = {
'a': [{ 'c': 3 }, { 'e': 5 }]
}
deepMerge(object, other)
// => { 'a': [{ 'b': 2, 'c': 3 }, { 'd': 4, 'e': 5 }] }
### deepFreeze
const frozen = deepFreeze(obj);
// frozen === obj
const frozenArr = deepFreeze(obj1, obj2, obj3);
// frozenArr[0] === obj1
// frozenArr[1] === obj2
// frozenArr[2] === obj3
```
### diff & patch
```js
const a = {
foo: {
bar: {
a: ["a", "b"],
b: 2,
c: ["x", "y"],
e: 100,
},
},
buzz: "world",
};
const b = {
foo: {
bar: {
a: ["a"],
b: 2,
c: ["x", "y", "z"],
d: "Hello, world!",
},
},
buzz: "fizz",
};
expect(patch(a, diff(a, b))).toEqual(b);
```