fix: add ignoreAtomics option to isModified() for better backwards compatibility with Mongoose 5 #14213
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.
Re: #14024
Summary
Some of the work we did to make
isModified()
more consistent with what paths Mongoose validates and sends to MongoDB caused some trouble for users, so this PR adds aignoreAtomics
option toisModified()
that can help smooth out the issues. Basically, with thisignoreAtomics
option,isModified()
will returnfalse
if passed an array path where the top-level array has a non-$set
atomic operator. So ifpost.comments
has a$push
and no$set
, thenpost.isModified('comments.0.title', { ignoreAtomics: true })
will returnfalse
.Examples