feat(NODE-3729): add withId to default return type for collection.find and collection.findOne #3039
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
dariakp
added
External Submission
dariakp
changed the title
dariakp
approved these changes
Nov 16, 2021
5 tasks
avaly
reviewed
Nov 18, 2021
Comment on lines
+733
to
+735
| find(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<WithId<TSchema>>; | ||
| find<T>(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<T>; | ||
| find(filter?: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<WithId<TSchema>> { |
There was a problem hiding this comment.
@PaulEndri I think adding WithId to the Filter type here was a mistake. The other Filter types in this file are not using it.
5 tasks
avaly
added a commit
to plexinc/papr
that referenced
this pull request
Dec 1, 2021
The following change in `mongodb` requires changes in the return types of `find*` methods to include `WithId`: - mongodb/node-mongodb-native#3039
2 tasks
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.
Description
What is changing?
Adding a
WithIdwrapper to the return type of collection.findOne and collection.findIs there new documentation needed for these changes?
No, should be self documented by ts output and is otherwise (probably) expected behavior
What is the motivation for this change?
Ran into a scenario similar to NODE-3729 and after seeing PR 3020 I wanted to suggest a more targeted solution that only impacts the find methods directly.
By changing only the return type of
.find(); the_idproperty is correctly returned on all find operations. I limited the change to only instances where the return type for.find()isn't overridden because at that point the user is stating they want manual control over the resulting type and are responsible for their own_iddefinition (if one exists).Double check the following
npm run check:lintscript<type>(NODE-xxxx)<!>: <description>