deepcopy

What is deepcopy?

The 'deepcopy' npm package is used to create deep copies of JavaScript objects. This means that it recursively copies all nested objects and arrays, ensuring that the new object is completely independent of the original.

What are deepcopy's main functionalities?

Deep Copy of Objects

This feature allows you to create a deep copy of an object, ensuring that nested objects are also copied.

const deepcopy = require('deepcopy');
const original = { a: 1, b: { c: 2 } };
const copy = deepcopy(original);
console.log(copy); // { a: 1, b: { c: 2 } }

Deep Copy of Arrays

This feature allows you to create a deep copy of an array, ensuring that nested arrays and objects are also copied.

const deepcopy = require('deepcopy');
const original = [1, [2, 3], { a: 4 }];
const copy = deepcopy(original);
console.log(copy); // [1, [2, 3], { a: 4 }]

Handling Circular References

This feature allows you to handle circular references in objects, ensuring that the deep copy process does not result in an infinite loop.

const deepcopy = require('deepcopy');
const original = { a: 1 };
original.b = original;
const copy = deepcopy(original);
console.log(copy); // { a: 1, b: [Circular] }

Other packages similar to deepcopy

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data types. It includes a `cloneDeep` function that performs deep copying similar to `deepcopy`. However, Lodash offers many additional utilities beyond deep copying.

rfdc

The 'rfdc' (Really Fast Deep Clone) package is designed for performance and provides a very fast way to deep clone objects. It is similar to `deepcopy` in functionality but is optimized for speed.

clone-deep

The 'clone-deep' package is another utility for deep cloning objects and arrays. It is similar to `deepcopy` but offers additional options for customizing the cloning process.

README

deepcopy.js

deep copy for any data

Installation

npm

$ npm install deepcopy

bower

$ bower install deepcopy

Usage

node.js

var deepcopy = require('deepcopy');

browser

<script src="deepcopy.min.js"></script>

define deepcopy by define() if using AMD loader.

otherwise deepcopy export to global.

Example

var data, shallow, deep;

data = {
  objects: {
    array: [
      null, undefined, new Date, /deepcopy/ig
    ],
    object: {
      number: NaN,
      string: 'A',
      boolean: true
    },
    to: null
  }
};

// circular reference
data.objects.to = data;

// shallow copy and deep copy
shallow = data;
deep = deepcopy(data);

// remove entry
delete data.objects;

// results
console.log(data);
// {}
console.log(shallow);
// {}
console.log(require('util').inspect(deep, { depth: null }));
// { objects:
//    { array:
//       [ null,
//         undefined,
//         Sat Jan 10 2015 03:18:32 GMT+0900 (JST),
//         /deepcopy/gi ],
//      object: { number: NaN, string: 'A', boolean: true },
//      to: [Circular] } }

Functions

deepcopy(value)

• value
  • * - copy target value
• return
  • * - deep copied value

return deep copied value.

supported types are below:

• Number
• String
• Boolean
• Null
• Undefined
• Function (shallow copy)
• Date
• RegExp
• Array
  • recursive copy
  • also can copy if it has circular reference
• Object
  • recursive copy
  • also can copy if it has circular reference
• Buffer (node.js only)

Test

node.js

$ npm install
$ npm test

browser

$ npm install
$ npm run bower
$ npm run testem

Contributors

• kjirou

License

The MIT license. Please see LICENSE file.

Changelog

0.4.0 / 2015-01-10

• refactored
• bugfix for Firefox
• supported for Buffer (node.js only)
• changed to use power-assert from expect.js