proxy-merge
Version:
Merge one or more objects using Proxy
68 lines (49 loc) • 1.75 kB
Markdown
# proxy-merge
[](https://www.npmjs.com/package/proxy-merge)
[](https://github.com/ktonon/proxy-merge/blob/master/LICENSE.txt)
[](https://circleci.com/gh/ktonon/proxy-merge)
Merge one or more objects using [Proxy][]. Flatten a proxy-merged object to remove the proxy.
```shell
npm install -S proxy-merge
```
## Examples
```javascript
const proxyMerge = require('proxy-merge');
```
Merge two (or more...) objects.
```javascript
const input0 = { foo: 'bar' };
const input1 = { age: 5 };
const obj = proxyMerge(input0, input1);
obj.foo; // => 'bar'
obj.age; // => 5
```
Only keys from the first input are listed with [Object.keys(obj)][]...
```javascript
Object.keys(obj); // => ['foo']
```
...but, the first input is not the output object.
```javascript
input0 === obj; // => false
```
Changes made to the input after merging will be reflected by the proxy-merged object.
```javascript
input0.change0 = 0;
input1.change1 = 1;
obj.change0; // => 0
obj.change1; // => 1
```
If you need a vanilla `Object`, use `.flatten(obj)`.
```javascript
const flat = proxyMerge.flatten(obj);
Object.keys(flat).sort(); // ['age', 'change0', 'change1', 'foo']
flat.age; // => 5
```
Changes made to the inputs are not reflected in the flattened object.
```javascript
input0.change2 = 2;
obj.change2; // => 2
flat.change2; // => undefined
```
[Object.keys(obj)]:https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/keys
[Proxy]:https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Proxy