clone-deep

What is clone-deep?

The clone-deep npm package is designed for deep cloning of objects, arrays, maps, sets, and primitive types in JavaScript. It ensures that when you clone a structure, you get a new structure with the same values but without references to the original objects, allowing for safe manipulation without affecting the original data.

What are clone-deep's main functionalities?

Cloning Objects

This feature allows for deep cloning of objects. The code demonstrates cloning an object and modifying the clone without affecting the original object.

const cloneDeep = require('clone-deep');
let obj = { a: 1, b: { c: 2 } };
let clonedObj = cloneDeep(obj);
clonedObj.b.c = 3;
console.log(obj.b.c); // 2

Cloning Arrays

This feature enables deep cloning of arrays. The code shows how an array is cloned and modified, with the original array remaining unchanged.

const cloneDeep = require('clone-deep');
let arr = [1, [2, 3]];
let clonedArr = cloneDeep(arr);
clonedArr[1][0] = 4;
console.log(arr[1][0]); // 2

Cloning Maps and Sets

This feature supports the deep cloning of Map and Set objects. The code illustrates cloning a Map and altering the clone without impacting the original Map.

const cloneDeep = require('clone-deep');
let map = new Map([[1, 'a']]);
let clonedMap = cloneDeep(map);
clonedMap.set(1, 'b');
console.log(map.get(1)); // 'a'

Other packages similar to clone-deep

lodash.clonedeep

Lodash's clonedeep method offers similar deep cloning functionality. It is part of the larger Lodash library, which provides a wide range of utility functions for JavaScript. Compared to clone-deep, lodash.clonedeep is part of a larger utility library, which might be preferable for projects already using Lodash for other purposes.

deep-copy

The deep-copy package also provides deep cloning capabilities. It focuses solely on deep cloning, similar to clone-deep. The main difference may lie in the specific implementation details and performance optimizations.

ramda

Ramda is a functional programming library that includes deep cloning capabilities among its wide array of functions. Compared to clone-deep, Ramda offers a more comprehensive toolkit for functional programming in JavaScript, which includes but is not limited to deep cloning.

README

clone-deep

Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save clone-deep

Usage

const cloneDeep = require('clone-deep');

let obj = { a: 'b' };
let arr = [obj];
let copy = cloneDeep(arr);
obj.c = 'd';

console.log(copy);
//=> [{ a: 'b' }]

console.log(arr);
//=> [{ a: 'b', c: 'd' }]

Heads up!

The last argument specifies whether or not to clone instances (objects that are from a custom class or are not created by the Object constructor. This value may be true or the function use for cloning instances.

When an instanceClone function is provided, it will be invoked to clone objects that are not "plain" objects (as defined by isPlainObjectisPlainObject). If instanceClone is not specified, this library will not attempt to clone non-plain objects, and will simply copy the object reference.

Attribution

Initially based on mout's implementation of deepClone.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• is-plain-object: Returns true if an object was created by the Object constructor. | homepage
• isobject: Returns true if the value is an object and not an array or null. | homepage
• kind-of: Get the native type of a value. | homepage
• shallow-clone: Creates a shallow clone of any JavaScript value. | homepage

Contributors

Commits	Contributor
46	jonschlinkert
2	yujunlong2000

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on November 21, 2018.