BREAKING CHANGE: Safer types for Model.distinct and Query.distinct.
#13836
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
kaulsh
force-pushed
the
safer-distinct-return-type
branch
from
9856e47 to
b951883
Compare
kaulsh
changed the title
Model.distinct and Query.distinct.Model.distinct and Query.distinct.
vkarpov15
approved these changes
Sep 8, 2023
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.
Summary
W.r.t issue #11306
This PR improves the type safety for the return type of
Model#distinctandQuery#distinct. It should behave more like Mongodb does, i.e., if you give something that isn't a key on the document, you would still get an empty array or maybe somethingunknown[]. If you do give the correct key from the schema, you'll get a type safe result.Note: This is not a backwards compatible change, as pointed out here: #11306 (comment)
Examples
The changes to the tests should be good enough examples. Can add more here if required.