Socket
Socket
Sign inDemoInstall

clone-deep

Package Overview
Dependencies
4
Maintainers
2
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

clone-deep

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


Version published
Maintainers
2
Weekly downloads
16,389,822
decreased by-8.47%

Weekly downloads

Package description

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

Readme

Source

clone-deep NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

You might also be interested in these projects:

Contributors

CommitsContributor
46jonschlinkert
2yujunlong2000

Author

Jon Schlinkert

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.

Keywords

FAQs

Last updated on 22 Nov 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc