docs(timestamps): clarify that replaceOne() and findOneAndReplace() overwrite timestamps
#14337
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
…)` overwrite timestamps Fix #14309
hasezoey
approved these changes
Feb 7, 2024
Comment on lines
+71
to
+72
| console.log(doc.createdAt); // 2022-02-26T17:08:14.008Z | ||
| console.log(doc.updatedAt); // 2022-02-26T17:08:14.008Z |
There was a problem hiding this comment.
maybe instead of logging times do a == to show that they equal? or is it possible the times may be slightly off?
There was a problem hiding this comment.
I think console.log() is better because 1) easier to copy/paste and see the output, 2) doesn't rely on loose equality - doc.updatedAt is a date instance, so == is fine but === is not
There was a problem hiding this comment.
yes i meant === (triple), forgot js particularity for a moment
hasezoey
added
the
docs
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.
Fix #14309
Summary
Our docs could be a bit more explicit about how
findOneAndReplace()andreplaceOne()update timestamps. Unfortunately there's no way for Mongoose to prevent overwriting timestamps in withreplaceOne()andfindOneAndReplace(), so we should document this and avoid implying that Mongoose prevents updatingcreatedAton all query methods.Examples