diff options
Diffstat (limited to 'node_modules/clone-deep/README.md')
| -rw-r--r-- | node_modules/clone-deep/README.md | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/node_modules/clone-deep/README.md b/node_modules/clone-deep/README.md new file mode 100644 index 0000000..7337291 --- /dev/null +++ b/node_modules/clone-deep/README.md @@ -0,0 +1,97 @@ +# clone-deep [](https://www.npmjs.com/package/clone-deep) [](https://npmjs.org/package/clone-deep) [](https://npmjs.org/package/clone-deep) [](https://travis-ci.org/jonschlinkert/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save clone-deep +``` + +## Usage + +```js +var cloneDeep = require('clone-deep'); + +var obj = {a: 'b'}; +var arr = [obj]; + +var copy = cloneDeep(arr); +obj.c = 'd'; + +console.log(copy); +//=> [{a: 'b'}] + +console.log(arr); +//=> [{a: 'b', c: 'd'}] +``` + +## Heads up! + +The `instanceClone` function is invoked to clone objects that are not "plain" objects (as defined by [isPlainObject](#isPlainObject)`isPlainObject`) if it is provided. If `instanceClone` is not specified, it will not attempt to clone non-plain objects, and will copy the object reference. + +## Attribution + +Based on [mout's](https://github.com/mout/mout) implementation of deepClone. + +## About + +<details> +<summary><strong>Contributing</strong></summary> + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +</details> + +<details> +<summary><strong>Running Tests</strong></summary> + +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: + +```sh +$ npm install && npm test +``` + +</details> + +<details> +<summary><strong>Building docs</strong></summary> + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb +``` + +</details> + +### Related projects + +You might also be interested in these projects: + +* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object "Returns true if an object was created by the `Object` constructor.") +* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.") +* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.") +* [shallow-clone](https://www.npmjs.com/package/shallow-clone): Make a shallow clone of an object, array or primitive. | [homepage](https://github.com/jonschlinkert/shallow-clone "Make a shallow clone of an object, array or primitive.") + +### Author + +**Jon Schlinkert** + +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) + +### License + +Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 16, 2017._
\ No newline at end of file |