deepmerge
Merge the enumerable attributes of two objects deeply.
example
var x = { foo: { bar: 3 },
array: [ { does: 'work', too: [ 1, 2, 3 ] } ] }
var y = { foo: { baz: 4 },
quux: 5,
array: [ { does: 'work', too: [ 4, 5, 6 ] }, { really: 'yes' } ] }
var expected = { foo: { bar: 3, baz: 4 },
array: [ { does: 'work', too: [ 1, 2, 3, 4, 5, 6 ] }, { really: 'yes' } ],
quux: 5 }
merge(x, y)
methods
var merge = require('deepmerge')
merge(x, y, [options])
Merge two objects x
and y
deeply, returning a new merged object with the
elements from both x
and y
.
If an element at the same key is present for both x
and y
, the value from
y
will appear in the result.
Merging creates a new object, so that neither x
or y
are be modified. However, child objects on x
or y
are copied over - if you to copy all values, you must pass true
to the clone option.
merge.all(arrayOfObjects, [options])
Merges two or more objects into a single result object.
var x = { foo: { bar: 3 } }
var y = { foo: { baz: 4 } }
var z = { bar: 'yay!' }
var expected = { foo: { bar: 3, baz: 4 }, bar: 'yay!' }
merge.all([x, y, z])
options
arrayMerge
The merge will also merge arrays and array values by default. However, there are nigh-infinite valid ways to merge arrays, and you may want to supply your own. You can do this by passing an arrayMerge
function as an option.
function concatMerge(destinationArray, sourceArray, options) {
destinationArray
sourceArray
options
return destinationArray.concat(sourceArray)
}
merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge })
clone
Defaults to false
. If clone
is true
then both x
and y
are recursively cloned as part of the merge.
install
With npm do:
npm install deepmerge
test
With npm do:
npm test
license
MIT