index.md

$override migration

Shallowly merges two iterable structures

Signature

path (String/Array) - The path to the item, that should be overridden

value (Any) - The value to merge with

subject (Object) - The object that contains the item

TYPE SIGNATURES

String -> Object -> Object -> Object
(String, Object) -> Object -> Object
(String, Object, Object) -> Object
Array -> Object -> Object -> Object
(Array, Object) -> Object -> Object
(Array, Object, Object) -> Object

EXAMPLE

const myObject = {
    rooms: {
        kitchen: {name: 'Kitchen'},
        living: {name: 'Living Rooms'}
    }
};

//
// Make the appartement awesome!
//
$override('rooms', { pool: {name: 'Freaking awesome pool table chamber!!!'} }, myObject);
// returns {
//     kitchen: {name: 'Kitchen'},
//     living: {name: 'Living Rooms'},
//     pool: {name: 'Freaking awesome pool table chamber!!!'}
// }

IMMUTABLE JS SUPPORT (DEPRECATED)

WARNING: Immutable JS support is deprecated. It will be removed entirely with the next major version of Plow JS (which will be 4.0.0). Until then, support for Immutable JS versions below (but not including) v4 - though discouraged - continues to work.

the following types are supported for values targeted by path:

List
OrderedMap
Map