Package Exports

extendr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (extendr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

extendr

Utilities for cloning, extending, and de-referencing objects in shallow, deep, and safe ways

Install

NPM

Install: npm install --save extendr
Module: require('extendr')

Browserify

Install: npm install --save extendr
Module: require('extendr')
CDN URL: //wzrd.in/bundle/extendr@3.3.1

Ender

Install: ender add extendr
Module: require('extendr')

Editions

This package is published with the following editions:

extendr aliases extendr/index.js which uses Editions to automatically select the correct edition for the consumers environment
extendr/source/index.js is Source + ESNext + Require
extendr/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

API

require('extendr').extend(target, ...objects) - shallow extend the properties from the objects into the target
require('extendr').deep(target, ...objects) - deep extend the properties from the objects into the target
require('extendr').defaults(target, ...objects) - shallow extend the properties from the objects into the target where the target's value is undefined or null
require('extendr').deepDefaults(target, ...objects) - deep extend the properties from the objects into the target where the target's value is undefined or null
require('extendr').clone(...objects) - deep extend the properties from the objects into a new object
require('extendr').dereference(object) - clones the object by traversing through it and setting up new instances of anything that can be referenced
require('extendr').dereferenceJSON(object) - clones the object by stringifying it, then parsing the result, to ensure all references are destroyed (objects that not plain objects or arrays will be lost)

Implementation

Extendr arguments can only be plain JavaScript objects, anything else will throw. This is intentional to guarantee consistency of references.
Object property values that are plain objects or arrays will be dereferenced. All other object types will keep their reference.