jsdoc-75lb/node_modules-3.4.0/deepmerge/README.markdown

An API documentation generator for JavaScript.

deepmerge
=========

Merge the enumerable attributes of two objects deeply.

example
=======

```js
var util = require('util')
var merge = require('deepmerge')

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' } ] }

console.log(util.inspect(merge(x, y), false, null))
```

output:

```js
{ foo: { bar: 3, baz: 4 },
  array: [ { does: 'work', too: [ 1, 2, 3, 4, 5, 6 ] }, { really: 'yes' } ],
  quux: 5 }
```

methods
=======

var merge = require('deepmerge')

merge(x, y)
-----------

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.

The merge is immutable, so neither `x` nor `y` will be modified.

The merge will also merge arrays and array values.

install
=======

With [npm](http://npmjs.org) do:

```
npm install deepmerge
```

For the browser, you can install with [bower](http://bower.io/):

```
bower install deepmerge
```

test
====

With [npm](http://npmjs.org) do:

```
npm test
```