clone
offers foolproof deep cloning of variables in JavaScript.
Installation
npm install clone
Example
var clone = require('clone');
var a, b;
a = { foo: { bar: 'baz' } };
b = clone(a);
a.foo.bar = 'foo';
console.log(b);
This will print:
{ foo: { bar: 'baz' } }
clone masters cloning simple objects (even with custom prototype), arrays,
Date objects, and RegEx objects. Everything is cloned recursively, so that you
can clone dates in arrays in objects, for example.
API
clone(obj, circular)
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
.
Circular References
var a, b;
a = { hello: 'world' };
a.myself = a;
b = clone(a);
console.log(b);
This will print:
{ hello: "world", myself: [Circular] }
So, b.myself
points to b
, not a
. Neat!
Bugs and Issues
If you encounter any bugs or issues, feel free to open an issue at
github.
License
Copyright © 2011-2012 Paul Vorbach
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.