179 lines
4.7 KiB
Markdown
179 lines
4.7 KiB
Markdown
# clone
|
||
|
||
[](http://travis-ci.org/pvorb/clone) [](http://npm-stat.com/charts.html?package=clone)
|
||
|
||
offers foolproof _deep cloning_ of objects, arrays, numbers, strings, maps,
|
||
sets, promises, etc. in JavaScript.
|
||
|
||
|
||
## Installation
|
||
|
||
npm install clone
|
||
|
||
(It also works with browserify, ender or standalone. You may want to use the
|
||
option `noParse` in browserify to reduce the resulting file size, since usually
|
||
`Buffer`s are not needed in browsers.)
|
||
|
||
|
||
## Example
|
||
|
||
~~~ javascript
|
||
var clone = require('clone');
|
||
|
||
var a, b;
|
||
|
||
a = { foo: { bar: 'baz' } }; // initial value of a
|
||
|
||
b = clone(a); // clone a -> b
|
||
a.foo.bar = 'foo'; // change a
|
||
|
||
console.log(a); // show a
|
||
console.log(b); // show b
|
||
~~~
|
||
|
||
This will print:
|
||
|
||
~~~ javascript
|
||
{ foo: { bar: 'foo' } }
|
||
{ foo: { bar: 'baz' } }
|
||
~~~
|
||
|
||
**clone** masters cloning simple objects (even with custom prototype), arrays,
|
||
Date objects, and RegExp objects. Everything is cloned recursively, so that you
|
||
can clone dates in arrays in objects, for example.
|
||
|
||
|
||
## API
|
||
|
||
`clone(val, circular, depth)`
|
||
|
||
* `val` -- the value that you want to clone, any type allowed
|
||
* `circular` -- boolean
|
||
|
||
Call `clone` with `circular` set to `false` if you are certain that `obj`
|
||
contains no circular references. This will give better performance if
|
||
needed. There is no error if `undefined` or `null` is passed as `obj`.
|
||
* `depth` -- depth to which the object is to be cloned (optional,
|
||
defaults to infinity)
|
||
* `prototype` -- sets the prototype to be used when cloning an object.
|
||
(optional, defaults to parent prototype).
|
||
* `includeNonEnumerable` -- set to `true` if the non-enumerable properties
|
||
should be cloned as well. Non-enumerable properties on the prototype chain
|
||
will be ignored. (optional, defaults to `false`)
|
||
|
||
`clone.clonePrototype(obj)`
|
||
|
||
* `obj` -- the object that you want to clone
|
||
|
||
Does a prototype clone as
|
||
[described by Oran Looney](http://oranlooney.com/functional-javascript/).
|
||
|
||
|
||
## Circular References
|
||
|
||
~~~ javascript
|
||
var a, b;
|
||
|
||
a = { hello: 'world' };
|
||
|
||
a.myself = a;
|
||
b = clone(a);
|
||
|
||
console.log(b);
|
||
~~~
|
||
|
||
This will print:
|
||
|
||
~~~ javascript
|
||
{ hello: "world", myself: [Circular] }
|
||
~~~
|
||
|
||
So, `b.myself` points to `b`, not `a`. Neat!
|
||
|
||
|
||
## Test
|
||
|
||
npm test
|
||
|
||
|
||
## Changelog
|
||
|
||
### v2.1.1
|
||
|
||
#### 2017-03-09
|
||
|
||
- Fix build badge in README
|
||
- Add support for cloning Maps and Sets on Internet Explorer
|
||
|
||
### v2.1.0
|
||
|
||
#### 2016-11-22
|
||
|
||
- Add support for cloning Errors
|
||
- Exclude non-enumerable symbol-named object properties from cloning
|
||
- Add option to include non-enumerable own properties of objects
|
||
|
||
### v2.0.0
|
||
|
||
#### 2016-09-28
|
||
|
||
- Add support for cloning ES6 Maps, Sets, Promises, and Symbols
|
||
|
||
### v1.0.2
|
||
|
||
#### 2015-03-25
|
||
|
||
- Fix call on getRegExpFlags
|
||
- Refactor utilities
|
||
- Refactor test suite
|
||
|
||
### v1.0.1
|
||
|
||
#### 2015-03-04
|
||
|
||
- Fix nodeunit version
|
||
- Directly call getRegExpFlags
|
||
|
||
### v1.0.0
|
||
|
||
#### 2015-02-10
|
||
|
||
- Improve browser support
|
||
- Improve browser testability
|
||
- Move helper methods to private namespace
|
||
|
||
## Caveat
|
||
|
||
Some special objects like a socket or `process.stdout`/`stderr` are known to not
|
||
be cloneable. If you find other objects that cannot be cloned, please [open an
|
||
issue](https://github.com/pvorb/clone/issues/new).
|
||
|
||
|
||
## Bugs and Issues
|
||
|
||
If you encounter any bugs or issues, feel free to [open an issue at
|
||
github](https://github.com/pvorb/clone/issues) or send me an email to
|
||
<paul@vorba.ch>. I also always like to hear from you, if you’re using my code.
|
||
|
||
## License
|
||
|
||
Copyright © 2011-2016 [Paul Vorbach](https://paul.vorba.ch/) and
|
||
[contributors](https://github.com/pvorb/clone/graphs/contributors).
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||
this software and associated documentation files (the “Software”), to deal in
|
||
the Software without restriction, including without limitation the rights to
|
||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||
subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all
|
||
copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, OUT OF OR IN CONNECTION WITH THE
|
||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|