types(model+query): use stricter typings for updateX(), replaceOne(),deleteX() Model functions #14228
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
… deleteX() Model functions Fix #14204
Closed
hasezoey
reviewed
Jan 2, 2024
Co-authored-by: hasezoey <hasezoey@gmail.com>
hasezoey
approved these changes
Jan 2, 2024
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 #14204
Summary
While Mongoose's current options typings are technically correct because of chaining, using stricter types in the Model functions that return a query lines up better with how developers use it. Plus with
[other: string]: any, devs can still use other options.I only made these changes for
deleteX(),replaceOne(), andupdateX()because Mongoose'sQueryOptionshas aprojectionproperty that doesn't line up exactly with the MongoDB Node driver's: the MongoDB Node driver'sprojectiontype is justRecord<string, any>, doesn't take into account schema definitions.Examples