Building Resilient Systems on AWS: Learn how to design and implement a resilient, highly available, fault-tolerant infrastructure on AWS.

Clone Anything with JavaScript

By David Walsh on July 17, 2012

One topic or concept that causes confusion when developers start with JavaScript is the idea of passing objects by reference; for example, setting two variables equal to the same object actually creates a reference to that same object. Sending an object to a function and modify that argument within the function actually modifies the original object. Sometimes we'd prefer to send around a clone of something, a date, array, or maybe an object literal. The Dojo Toolkit provides an excellent method for cloning just about anything. Even better is that the functionality is easy to pull out of Dojo for your own toolkit.

The JavaScript

The clone method will deep clone nodes, object literals, arrays, dates, regular expressions, and generic objects:

function clone(src) {
	function mixin(dest, source, copyFunc) {
		var name, s, i, empty = {};
		for(name in source){
			// the (!(name in empty) || empty[name] !== s) condition avoids copying properties in "source"
			// inherited from Object.prototype.	 For example, if dest has a custom toString() method,
			// don't overwrite it with the toString() method that source inherited from Object.prototype
			s = source[name];
			if(!(name in dest) || (dest[name] !== s && (!(name in empty) || empty[name] !== s))){
				dest[name] = copyFunc ? copyFunc(s) : s;
			}
		}
		return dest;
	}

	if(!src || typeof src != "object" || Object.prototype.toString.call(src) === "[object Function]"){
		// null, undefined, any non-object, or function
		return src;	// anything
	}
	if(src.nodeType && "cloneNode" in src){
		// DOM Node
		return src.cloneNode(true); // Node
	}
	if(src instanceof Date){
		// Date
		return new Date(src.getTime());	// Date
	}
	if(src instanceof RegExp){
		// RegExp
		return new RegExp(src);   // RegExp
	}
	var r, i, l;
	if(src instanceof Array){
		// array
		r = [];
		for(i = 0, l = src.length; i < l; ++i){
			if(i in src){
				r.push(clone(src[i]));
			}
		}
		// we don't clone functions for performance reasons
		//		}else if(d.isFunction(src)){
		//			// function
		//			r = function(){ return src.apply(this, arguments); };
	}else{
		// generic objects
		r = src.constructor ? new src.constructor() : {};
	}
	return mixin(r, src, clone);

}

The code provided by Dojo also has the ability to clone functions, but that ability is disabled for performance reasons. I've placed the mixin function within clone itself, but that can also be defined at the same level and you can use mixin as a general function for merging objects. This method, of course, is just one of a thousand helpful snippets you can find within the Dojo Toolkit!

Recent Features

By Soledad PenadésJuly 22, 2014
From Webcam to Animated GIF: the Secret Behind chat.meatspac.es!
My team mate Edna Piranha is not only an awesome hacker; she's also a fantastic philosopher! Communication and online interactions is a subject that has kept her mind busy for a long time, and it has also resulted in a bunch of interesting experimental projects...
By Landon SchroppApril 14, 2014
Write Better JavaScript with Promises
You've probably heard the talk around the water cooler about how promises are the future. All of the cool kids are using them, but you don't see what makes them so special. Can't you just use a callback? What's the big deal? In this article, we'll...

Incredible Demos

By David WalshMarch 1, 2010
Link Nudging Using Dojo
In the past we've tinkered with link nudging with MooTools and link nudging with jQuery. In an effort to familiarize myself with other JavaScript frameworks, we're going to try to duplicate that effect with another awesome framework: Dojo. The JavaScript: Attempt...
By David WalshJanuary 26, 2010
jQuery UI DatePicker: Disable Specified Days
One project I'm currently working on requires jQuery. The project also features a datepicker for requesting a visit to their location. jQuery UI's DatePicker plugin was the natural choice and it does a really nice job. One challenge I encountered was the...

Discussion

wiky
There are an idea to clone an object(or array) by JSON method without deep traversal:
```
function clone (src) {
    return JSON.parse(JSON.stringify(src));
}
```
But it only supports to clone Object and need JSON support.
Steve
Thanks David… I’m sure at some point this might be handy… ditto WIKY… that’s a great *simple* approach… I wonder if there’s any issues with that? (other than lack of support on legacy browsers)
Andres D
David, see this for clone funcion http://stackoverflow.com/questions/1833588/javascript-clone-a-function
run example http://jsfiddle.net/adescalzo/2hTJj/
Miller Medeiros
I implemented something similar on amd-utils/lang/clone. It handles RegExp flags properly (missing on the snippet above) and avoid IE don’t enum bug. I also find the code more readable ;-D

Element.cloneNode(true) is so easy to type that I don’t think it’s worth the overhead on the clone() method, I would definitely keep it just to JavaScript natives.

Cheers.
Rasmus Fløe
The dojo source is scary! :(

The intent is good but…

I don’t understand why they wouldn’t just use hasOwnProperty instead of having an empty object and checking against that. Yikes. Must have a good reason I guess… :/

And then there’s the rather naive expectation that typeof would ever return “array”!?
if(src && (src instanceof Array || typeof src == "array")){

David Walsh
I am seeing that now; I’ll bring it up with the Dojo team, as these items are quite odd.
David Walsh
OK, the SRC check in that statement was my bad on the translation. The typeof does exist in Dojo, not sure why that’s there.

Paul Bronshteyn
Looping though the arrays to clone then is slow, using native methods are much faster:

r = src.concat([]);

Miller Medeiros
concat doesn’t do a deep clone (objects and arrays inside of it aren’t cloned).
christ almighty
what you’re describing is not a “deep clone”.

any non-primitive item (Array, Object, etc) in the Array will be passed as a reference, it will not be a copy, so changing an item in the cloned Array (e.g. popping an item off an Array nested within it) will also alter the original.

this may or may not be the behaviour you want, but it is important enough for me to come back down to earth and school your sorry @$$ as to why you should think before you comment.

christ almighty

Without including all the implementation faff, a more sexual solution might look like:

var clone = function() {
    function mixin( dest, source, copyFunc ) {}

    return function clone( src ) {

        var type = Object.prototype.toString.call( src ).substring( 8 ).split( ']' )[0].toLowerCase();
    
        switch ( type ) {
            case 'function'  : break;
            case 'array'     : break;
            case 'object'    : 
                if ( !src.constructor || src.constructor === Object ) {} // <- handles Object.create( null );
                else return new src.constructor();
                break;
            case 'regexp'    : break;
            case 'date'      : break;
            case 'undefined' : case 'null' : break;
            default          : 
                if ( type.indexOf( 'html' ) === 0 ) {}
        }
        return mixin( /*r, src, clone */ );
    };
}();

switch always looks more sexual, your making the switch, it’s definite, you’re an attractive assertive go getter. A bunch of ifs? too iffy… also, moving the mixin function out of the clone function is mucho nice-u and mean you’re not recreating it each time this method is called!

jesus, just sayin’….

christ almighty
formatting!!! :P

psychedesire

Hello ! I am Japanese !
I am Beginner of Javascript.
This code will do bad?

var clone = function(o){
	var Clone = function(o){
		var self = this;
		if(o instanceof Array){
			for(var i = 0,l = o.length;i < l;++ i){
				self[i] = o[i];
			}
		}else{
			for(var n in o){
				self[n] = o[n];
			}
		}
	};
	if((!o)||(typeof(o) !== "object")){
		return o;
	}else{
		o = new Clone(o);
		return o;
	}
};

myObject = {foo:"bar",deep:{func:function(){alert("do something");}}};
var cloned = clone(myObject);
alert(cloned.foo) //bar
myObject.foo = "bbbbbbbb";
alert(cloned.foo) //bar
cloned.deep.func(); // do something

jhuesos
I was checking briefly the code and I found this line:

if(src instanceof Array){

Which is consider not the best way to check if a variable is an Array (it won’t work when dealing with multi-frames).
BitDagger
@JHUESOS

What’s the proper way of checking that then?
Francisc
Hey David,

Awesome post.
A question though, should typeof src!="object" be typeof src!=="object"?

Me
typeof will always return a string

Markus Staab
When jquery is available it is rather easy

Clone object: clone = jQuery.extend({}, obj);

Clone array: clone = jQuery.extend([], arr);
Cody
For arrays, a more traditional way is:
```
var arr = [1,2,3];
var newArr = arr.slice(0);  // zero is optional
console.log(arr === newArr, newArr);
```
But this is probably outside of what David is actually aiming to accomplish as his function uses autonomy.

Thanks David!

André Padez

Dave, I changed the repo, and a bit of the code:
(if you can delete my previous comment)
https://github.com/andrepadez/better-objects

Object.prototype.clone = function() {
    var theClone;

    var traverseObject = function(obj, clone){
        Object.keys(obj).forEach(function(key){
            if(Array.isArray(obj[key])){
                clone[key] = traverseArray(obj[key])
            } 
            else if(typeof obj[key] === 'object'){
                clone[key] = {};
                traverseObject(obj[key], clone[key]);
            } 
            //we don't clone functions for performance reasons
            // else if(typeof obj[key] === 'function'){
            //     clone[key] = eval(obj[key].toString());
            // }
            else {
                clone[key] = obj[key];
            }
        });
    };

    var traverseArray = function(arr){
        var finalArray = [];
        arr.forEach(function(item){
            if(Array.isArray(item)){
                finalArray.push( traverseArray(item) );
            }
            else if(typeof item === 'object'){
                var newObj = {};
                traverseObject(item, newObj)
                finalArray.push( newObj );
            } 
            else {
                finalArray.push(item);
            }
        });
        return finalArray;
    }; 

    if( Array.isArray(this) ){
        theClone = traverseArray(this);
    } else {
        theClone = {};
        traverseObject(this, theClone);    
    }
    
    return theClone;
};

Robin Cafolla

Hi David,

You may want to add the following to allow cloning of TypedArrays

if(Object.prototype.toString.call(src.buffer) === "[object ArrayBuffer]"){
    return new src.constructor( src );
}

Andy
You probably don’t want to go implementing your own clone method – just use the NPM clone package https://www.npmjs.com/package/clone which is actively maintained, and handles circular dependencies. However, the npm package may not clone DOM nodes, but you should probably just us the native browser API if you really have to do that. This isn’t a wheel you need to reinvent!
Geoffrey D Hoffman
If I have a js file that uses Facebook, it calls fbq(‘init’… then another script also calls fbq(‘init’… so how do I ensure that I get my version? Of course this is all happening on a 3rd party site I don’t control, I can only control my script. I need to ensure that subsequent calls to fbq have the correct ID. Do you have any suggestions?

Clone Anything with JavaScript

The JavaScript

Recent Features

From Webcam to Animated GIF: the Secret Behind chat.meatspac.es!

Write Better JavaScript with Promises

Incredible Demos

Link Nudging Using Dojo

jQuery UI DatePicker: Disable Specified Days

Discussion