Have ideas to improve npm?Join in the discussion! »

object-extender

2.0.4 • Public • Published

Object-Extender

A set of simple utilities for copying, merging and manipulating plain objects.

Caution! Danger of Death!

This module is built upon the Object-Assign-Deep module and is subject to the same restrictions. Please see the warning in that project's readme before you use this module. Kittens' lives are at stake!

Quick Start

All the methods do a deep clone of objects and break references, except where specified.

const extender = require(`object-extender`);
 
// Merging objects without mutating any of them.
const mergedObjects = extender.merge(object1, object2, ...objectN);
 
// Merging objects into a target object (mutates the target).
extender.mergeInto(target, object1, object2, ...objectN);
extender.mixin(target, object1, object2, ...objectN);  // Alias of mergeInto()
 
// Clone a single object.
const clonedObject = extender.clone(originalObject);
const clonedObject = extender.copy(originalObject);  // Alias of clone()

Custom Behaviour

You can use the .extend() method to customise the behaviour of the module.

Ignoring Null or Undefined Values

You can optionally ignore null and undefined values in all but the first object by using the .extend() method. This allows you to avoid null or undefined values in object2 (or later) from overwriting valid values that exist in earlier objects. Simply pass in the ignoreNull or ignoreUndefined options.

Example:

const mergedObjects = extender.extend([
    { prop1: `Josh`, prop2: `Cole`, },
    { prop1: null, prop2: undefined, prop3: `Node` },
], {
    ignoreNull: true,
    ignoreUndefined: true,
});

Expected Output:

{
    prop1: `Josh`,
    prop2: `Cole`,
    prop3: `Node`,
}

Merging Arrays

By default, arrays are overwritten by later values so if you had two objects both with an array1 property, the array in the latter object would win out:

// Merging these two objects...
{ array1: [1, 2, 4] }
{ array1: [5, 6, 7] }
 
// ...would by default result in:
{ array1: [5, 6, 7] }

You can instead choose to merge the arrays by passing in the arrayBehaviour option and setting it to "merge":

Example:

const mergedObjects = extender.extend([
    { array1: [1, 2, 4] },
    { array1: [5, 6, 7] },
], {
    arrayBehaviour: `merge`,
});

Expected Output:

{
    array1: [1, 2, 4, 5, 6, 7],
}

Default Values

A useful method for passing lots of values into a function which need default values, and optionally some read-only values too.

Parameters:

  • defaultValues - An object containing default values.
  • actualValues - An object containing the actual values that are being set.
  • readOnlyValues - An optional object containing values which should not be changed.

Example:

extender.defaults({
    prop1: `Hello`,
    prop2: `World`,
    prop3: `Node`,
    special: null,
}, {
    prop1: `Josh`,
    prop2: `Cole`,
    special: false,
}, {
    special: true,
});

Expected Output:

{
    prop1: `Josh`,
    prop2: `Cole`,
    prop3: `Node`,
    special: true,
}

API Overview

.merge(object1, object2, ...objectN)

Merge all objects without mutating any of them and returns a fresh new object.

.mergeInto(target, object1, object2, ...objectN)

Merge all objects into the target, mutating the target and returning it.

.mixin(target, object1, object2, ...objectN)

Alias for .mergeInto().

.clone(originalObject)

Creates a fresh new copy of the object and returns it.

.copy(originalObject)

Alias for .clone().

.defaults(defaultValues, actualValues, readOnlyValues)

An easy way to pass lots of parameters into a function by providing a hash of default values, an object containing the actual values to set, and optionally, a hash of read-only values that should not be changed by the actual values. This is essentially just an alias to .merge() but with only three parameters.

.extend(objects, options)

Allows the behaviour of the module to be customised by providing an array of objects to merge and a number of options. Always returns a fresh new object without mutating any of the objects provided.

Option Default Value Description
ignoreNull false Set to true to prevent any properties in latter objects that are null from overwriting earlier values.
ignoreUndefined false Set to true to prevent any properties in latter objects that are undefined from overwriting earlier values.
arrayBehaviour "replace" By default arrays in later objects will overwrite earlier values, but you can set this to "merge" if you want to concatenate the arrays instead.

Install

npm i object-extender

DownloadsWeekly Downloads

19

Version

2.0.4

License

MIT

Unpacked Size

9.45 kB

Total Files

4

Last publish

Collaborators

  • avatar