Because objects in #JavaScript are references values, you can't simply just copy using the =
. But no worries, here are 3 ways for you to clone an object π
const food = { beef: 'π₯©', bacon: 'π₯' }
// "Spread"
{ ...food }
// "Object.assign"
Object.assign({}, food)
// "JSON"
JSON.parse(JSON.stringify(food))
// RESULT:
// { beef: 'π₯©', bacon: 'π₯' }
Objects are Reference Types
Your first question might be, whey can't I use =
. Let's see what happens if we do that:
const obj = {one: 1, two: 2};
const obj2 = obj;
console.log(
obj, // {one: 1, two: 2};
obj2 // {one: 1, two: 2};
)
So far, both object seems to output the same thing. So no problem, right. But let's see what happens if we edit our second object:
const obj2.three = 3;
console.log(obj2);
// {one: 1, two: 2, three: 3}; <-- β
console.log(obj);
// {one: 1, two: 2, three: 3}; <-- π±
WTH?! I changed obj2
but why was obj
also affected. That's because Objects are reference types. So when you use =
, it copied the pointer to the memory space it occupies. Reference types don't hold values, they are a pointer to the value in memory.
If you want to learn more about this, check out Gordon's Zhu Watch and Code course. It's free to enroll and watch the video "Comparison with objects". He gives a super awesome explanation on it.
Using Spread
Using spread will clone your object. Note this will be a shallow copy. As of this post, the spread operator for cloning objects is in Stage 4. So it's not officially in the specifications yet. So if you were to use this, you would need to compile it with Babel (or something similar).
const food = { beef: 'π₯©', bacon: 'π₯' };
const cloneFood = { ...food };
console.log(cloneFood);
// { beef: 'π₯©', bacon: 'π₯' }
Using Object.assign
Alternatively, Object.assign
is in the official released and also create a shallow copy of the object.
const food = { beef: 'π₯©', bacon: 'π₯' };
const cloneFood = Object.assign({}, food);
console.log(cloneFood);
// { beef: 'π₯©', bacon: 'π₯' }
Using JSON
This final way will give you a deep copy. Now I will mention, this is a quick and dirty way of deep cloning an object. For a more robust solution, I would recommend using something like lodash
const food = { beef: 'π₯©', bacon: 'π₯' };
const cloneFood = JSON.parse(JSON.stringify(food))
console.log(cloneFood);
// { beef: 'π₯©', bacon: 'π₯' }
Lodash DeepClone vs JSON
Here's a comment from the community. Yes, it was for my previous post, How to Deep Clone an Array. But the idea still applies to objects.
Alfredo Salzillo: I'd like you to note that there are some differences between deepClone and JSON.stringify/parse.
- JSON.stringify/parse only work with Number and String and Object literal without function or Symbol properties.
- deepClone work with all types, function and Symbol are copied by reference.
Here's an example:
const lodashClonedeep = require("lodash.clonedeep");
const arrOfFunction = [() => 2, {
test: () => 3,
}, Symbol('4')];
// deepClone copy by refence function and Symbol
console.log(lodashClonedeep(arrOfFunction));
// JSON replace function with null and function in object with undefined
console.log(JSON.parse(JSON.stringify(arrOfFunction)));
// function and symbol are copied by reference in deepClone
console.log(lodashClonedeep(arrOfFunction)[0] === lodashClonedeep(arrOfFunction)[0]);
console.log(lodashClonedeep(arrOfFunction)[2] === lodashClonedeep(arrOfFunction)[2]);
@OlegVaraksin: The JSON method has troubles with circular dependencies. Furthermore, the order of properties in the cloned object may be different.
Shallow Clone vs Deep Clone
When I used spread ... to copy an object, I'm only creating a shallow copy. If the array is nested or multi-dimensional, it won't work. Let's take a look:
const nestedObject = {
country: 'π¨π¦',
{
city: 'vancouver'
}
};
const shallowClone = { ...nestedObject };
// Changed our cloned object
clonedNestedObject.country = 'πΉπΌ'
clonedNestedObject.country.city = 'taipei';
So we changed our cloned object by changing the city. Let's see the output.
console.log(shallowClone);
// {country: 'πΉπΌ', {city: 'taipei'}} <-- β
console.log(nestedObject);
// {country: 'π¨π¦', {city: 'taipei'}} <-- π±
A shallow copy means the first level is copied, deeper levels are referenced.
Deep Copy
Let's take the same example but apply a deep copy using "JSON"
const deepClone = JSON.parse(JSON.stringify(nestedObject));
console.log(deepClone);
// {country: 'πΉπΌ', {city: 'taipei'}} <-- β
console.log(nestedObject);
// {country: 'π¨π¦', {city: 'vancouver'}} <-- β
As you can see, the deep copy is a true copy for nested objects. Often time shallow copy is good enough, you don't really need a deep copy. It's like a nail gun vs a hammer. Most of the time the hammer is perfectly fine. Using a nail gun for some small arts and craft is often case an overkill, a hammer is just fine. It's all about using the right tool for the right job π€
Performance
Unfortunately, I can't write a test for spread because it's not officially in the spec yet. Nevertheless, I included it in the test so you can run it in the future. But the result shows Object.assign
is a lot faster than JSON
.
Community Input
Object.assign vs Spread
@d9el: It's important to note that Object.assign is a function which modifies and returns the target object. In Samantha's example using the following,
const cloneFood = Object.assign({}, food)
{}
is the object that is modified. The target object is not referenced by any variable at that point, but because Object.assign
returns the target object, we are able to store the resulting assigned object into the cloneFood
variable. We could switch our example up and use the following:
const food = { beef: 'π½', bacon: 'π₯' };
Object.assign(food, { beef: 'π₯©' });
console.log(food);
// { beef: 'π₯©', bacon: 'π₯' }
Obviously, the value of beef
in our food object is wrong, so we can assign the correct value of beef
using Object.assign
. We aren't actually using the returned value of the function at all, but we are modifying our target object which we have referenced with the const food
.
Spread on the other hand is an operator which copies properties of one object into a new object. If we wanted to replicate the above example using spread to modify our variable food...
const food = { beef: 'π½', bacon: 'π₯' };
food = {
...food,
beef: 'π₯©',
}
// TypeError: invalid assignment to const `food'
```
`...` we get an error, because we use spread when creating new objects, and therefore are assigning a whole new object to `food` which was declared with `const`, which is illegal. So we can either choose to declare a new variable to hold our new object in, like the following:
```javascript
const food = { beef: 'π½', bacon: 'π₯' };
const newFood = {
...food,
beef: 'π₯©',
}
console.log(newFood);
// { beef: 'π₯©', bacon: 'π₯' }
```
or we could declare `food` with `let` or `var` which would allow us to assign a whole new object:
```javascript
let food = { beef: 'π½', bacon: 'π₯' };
food = {
...food,
beef: 'π₯©',
}
console.log(food);
// { beef: 'π₯©', bacon: 'π₯' }
```
_Thanks: [@d9el](https://dev.to/adameier/comment/d9el)_
### Deep Clone using External Libraries
- _[@lesjeuxdebebel](https://twitter.com/lesjeuxdebebel/status/1153259251705503744):_ Personally I use jquery with `$.extend();` function
- _[@edlinkiii](https://twitter.com/edlinkiii/status/1153035836356747267):_ underscore.js ~~ `_.clone()`
- _[@Percy_Burton](https://twitter.com/Percy_Burton/status/1152671704155660289):_ The only way I've known to do this is with the Lodash library, cloneDeep method.
### More Ways using JavaScript
- _[@hariharan_d3v](https://twitter.com/hariharan_d3v/status/1152815791009460224):_ `Object.fromEntries(Object.entries(food))` [shallow] clones the object.
**π¬ What other ways do you know how to clone an object? Drop them in the comments π**
---
## Resources
- [MDN Web Docs: Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
- [Stack Overflow: What is the most efficient way to deep clone an object in JavaScript?](https://stackoverflow.com/questions/122102/what-is-the-most-efficient-way-to-deep-clone-an-object-in-javascript)
- [2ality: Rest/Spread Properties](https://2ality.com/2016/10/rest-spread-properties.html)
- [Stack Overflow: Object spread vs. Object.assign](https://stackoverflow.com/questions/32925460/object-spread-vs-object-assign)
---
**Thanks for reading β€**
Say Hello! [Instagram](https://www.instagram.com/samanthaming/) | [Twitter](https://twitter.com/samantha_ming) | [Facebook](https://www.facebook.com/hisamanthaming) | [Blog](https://www.samanthaming.com/blog) | [SamanthaMing.com](https://www.samanthaming.com/)
Top comments (9)
Also have some issues when clone object with
JSON.parse(JSON.stringify)
Can you check?
I should of mentioned...the JSON method wonβt be able to clone methods π£
Check out this article, it has more info:
google.ca/amp/s/scotch.io/bar-talk...
Thank you,
And I have some questions about this,
When I copy:
obj.n2
andnewObj.n2
are the same?And as in my previous comment, when I copy:
Another question, when I create an object by
Object.create
like this:Why that, we cannot clone it without readable it? Please help me understand, thank you!
What is difference between spread and object.assign?
I'ts important to note that
Object.assign
is a function which modifies and returns the target object. In Samantha's example using the following,{}
is the object that is modified. The target object is not referenced by any variable at that point, but becauseObject.assign
returns the target object, we are able to store the resulting assigned object into thecloneFood
variable. We could switch our example up and use the following:Obviously the value of
beef
in ourfood
object is wrong, so we can assign the correct value ofbeef
usingObject.assign
. We aren't actually using the returned value of the function at all, but we are modifying our target object which we have referenced with the constfood
.Spread on the other hand is an operator which copies properties of one object into a new object. If we wanted to replicate the above example using spread to modify our variable
food
......we get an error, because we use spread when creating new objects, and therefore are assigning a whole new object to
food
which was declared withconst
, which is illegal. So we can either choose to declare a new variable to hold our new object in, like the following:or we could declare
food
withlet
orvar
which would allow us to assign a whole new object:Got it. Thank you!
Thanks for chiming in and helping answer this question. This is great, let me add it to the code notes π
Thu explanation is swift. Thanks
I don't think there is a difference aside from syntax in this case. The triple dot expression
...
also means rest which does not meanObject.assign
.For more information see 2ality.com/2016/10/rest-spread-pro...