Built-In Namespace _global_
Method Attributes | Method Name and Description |
---|---|
createOptions(opts)
Creates a new options object suitable for use with objectMerge.
|
|
objectMerge(opts, shadows)
Merges JavaScript objects recursively without altering the objects merged.
|
Method Detail
{ObjectMergeOptions}
createOptions(opts)
Creates a new options object suitable for use with objectMerge.
Defined in: <src/object-merge.js>.
Defined in: <src/object-merge.js>.
- Parameters:
- {Object} opts Optional
- An object specifying the options.
- Returns:
- {ObjectMergeOptions} Returns an instance of ObjectMergeOptions to be used with objectMerge.
{Object}
objectMerge(opts, shadows)
Merges JavaScript objects recursively without altering the objects merged.
Defined in: <src/object-merge.js>.
Author: Matthew Kastor.
Defined in: <src/object-merge.js>.
Author: Matthew Kastor.
var objectMerge = require('object-merge'); var x = { a : 'a', b : 'b', c : { d : 'd', e : 'e', f : { g : 'g' } } }; var y = { a : '`a', b : '`b', c : { d : '`d' } }; var z = { a : { b : '``b' }, fun : function foo () { return 'foo'; }, aps : Array.prototype.slice }; var out = objectMerge(x, y, z); // out.a will be { // b : '``b' // } // out.b will be '`b' // out.c will be { // d : '`d', // e : 'e', // f : { // g : 'g' // } // } // out.fun will be a clone of z.fun // out.aps will be equal to z.aps
- Parameters:
- {ObjectMergeOptions} opts Optional
- An options object created by objectMerge.createOptions. Options must be specified as the first argument and must be an object created with createOptions or else the object will not be recognized as an options object and will be merged instead.
- {Object} shadows
- [[shadows]...] One or more objects to merge. Each argument given will be treated as an object to merge. Each object overwrites the previous objects descendant properties if the property name matches. If objects properties are objects they will be merged recursively as well.
- Returns:
- {Object} Returns a single merged object composed from clones of the input objects.