-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Lodash guide highlighting issues with cloneDeep()
Fix #12559
- Loading branch information
Showing
3 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Using Mongoose with Lodash | ||
|
||
For the most part, Mongoose works well with [Lodash](https://lodash.com/). | ||
However, there are a few caveats that you should know about. | ||
|
||
* [`cloneDeep()`](#clonedeep) | ||
|
||
## `cloneDeep()` | ||
|
||
You should not use [Lodash's `cloneDeep()` function](https://lodash.com/docs/4.17.15#cloneDeep) on any Mongoose objects. | ||
This includes [connections](./connections.html), [model classes](./models.html), and [queries](./queries.html), but is _especially_ important for [documents](./documents.html). | ||
For example, you may be tempted to do the following: | ||
|
||
```javascript | ||
const _ = require('lodash'); | ||
|
||
const doc = await MyModel.findOne(); | ||
|
||
const newDoc = _.cloneDeep(doc); | ||
newDoc.myProperty = 'test'; | ||
await newDoc.save(); | ||
``` | ||
|
||
However, the above code will throw the following error if `MyModel` has any array properties. | ||
|
||
```no-highlight | ||
TypeError: this.__parentArray.$path is not a function | ||
``` | ||
|
||
This is because Lodash's `cloneDeep()` function doesn't [handle proxies](https://stackoverflow.com/questions/50663784/lodash-clonedeep-remove-proxy-from-object), and [Mongoose arrays are proxies as of Mongoose 6](https://thecodebarbarian.com/introducing-mongoose-6.html#arrays-as-proxies). | ||
You typically don't have to deep clone Mongoose documents, but, if you have to, use the following alternative to `cloneDeep()`: | ||
|
||
```javascript | ||
const doc = await MyModel.findOne(); | ||
|
||
const newDoc = new MyModel().init(doc.toObject()); | ||
newDoc.myProperty = 'test'; | ||
await newDoc.save(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters