sphinx
v0.1.2
Published
Recursively merges and guards your objects against unwanted tampering.
Downloads
51
Maintainers
Readme
Sphinx
Recursively merges and guards your objects against unwanted tampering.
Features
Sphinx guards your objects during a merge by allowing you to:
- only change the values for properties that exist on the destination object.
- only change the values for properties that are of the same type as the destination object.
Getting Started
npm install --save sphinx
Usage
var sphinx = require( "sphinx" );
var destination = { foo: "bar" };
var source = { foo: "qux" };
var merged = sphinx.merge( destination, source );
//=> { foo: "qux" }
Examples
- Trying to add a property that doesn't exist on the destination object.
var destination = { foo: "bar" };
var source = { baz: "qux" };
var merged = sphinx.merge( destination, source );
//=> [Error: Property "baz" does not exist on destination object]
- Trying to merge a property of a mismatched type.
var destination = { foo: "bar" };
var source = { foo: 1 };
var merged = sphinx.merge( destination, source );
//=> [TypeError: Expected property "foo" to be a [object String]]
API
sphinx.merge( destination, object )
Name | Type | Argument | Default | Description
---------------|-----------|--------------|---------|------------
destination | Object
| <required>
| null
| The destination object.
source | Object
| <required>
| null
| The source object.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.
License
Copyright (c) 2014 Jason Bellamy
Licensed under the MIT license.