Add clarification about overwrite flag in model.js #12447
Merged
Conversation
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
Add calrification for using the `overwrite` flag in model.findByIdAndUpdate and model.findOneAndUpdate
Uzlopak
changed the title
Uzlopak
requested changes
Sep 20, 2022
|
@Uzlopak What did you have in mind? |
hasezoey
approved these changes
Sep 22, 2022
There was a problem hiding this comment.
LGTM, i think it helps having a note to the option to prevent the automatic extra behavior form happening (if the option exists) in the example itself
some small things to suggest to keep the naming more consistent
Edit: i think the option itself should maybe be renamed instead of just overwrite to something like originalBehavior or noSet or noAutoSet or something along these lines, but this would be a breaking change
Co-authored-by: hasezoey <hasezoey@gmail.com>
Co-authored-by: hasezoey <hasezoey@gmail.com>
|
Great, thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add calrification for using the
overwriteflag in model.findByIdAndUpdate and model.findOneAndUpdateSummary
The way mongoose changes the update behaviour (adds
$setto the update command) and how to prevent it is not intirely clear.I believe this note could help save some time and effort for future users.