fix: missing typescript details on options params of updateMany, updateOne, etc. #14382
Conversation
This file contains hidden or 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
Closed
2 tasks
Contributor
| Can't formally review, but LGTM! |
vkarpov15 approved these changes Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Fixes #14378
Summary
Fixes the missing typescript details from the
optionsparameter of functions likeupdateMany(),updateOne(), etc. The issue happened because theOmitinOmit<MongooseQueryOptions<TRawDocType>, 'lean'>was making the type of the keys vague becauseMongooseQueryOptionscontains[other: string]: any. To fix this, introdduced a new TS Util function calledExcludeKeyswhich fixes this logic without weakening the typeExamples
The property
timestampsand other such params are now visibleIts still supporting arbitrary options like
fallbackwithout any type issues