Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives. Used by superstruct, merge-deep, and many others!
Clone or download
Latest commit fb63468 Nov 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig run update, lint, update dependencies Jul 16, 2017
.eslintrc.json run update Apr 10, 2018
.gitattributes first commit Feb 26, 2015
.gitignore run update Jan 19, 2018
.npmrc run update Apr 10, 2018
.travis.yml run update, improve readme Nov 21, 2018
.verb.md run update, improve readme Nov 21, 2018
LICENSE run update Jan 19, 2018
README.md run update, improve readme Nov 21, 2018
index.js Merge pull request #16 from NJWong/master Nov 21, 2018
package.json 4.0.1 Nov 22, 2018
test.js add test for instanceClone May 9, 2018

README.md

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 ❤️ 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:

Contributors

Commits Contributor
46 jonschlinkert
2 yujunlong2000

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.