Update mongodb-dependent type parameters #11688
Merged
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
mongodb.Collection and mongodb.ChangeStream now both require that their type arguments `extend mongodb.Document`. This requires adding this constraint in a few places.
sandersn
commented
Apr 19, 2022
This was referenced Apr 19, 2022
|
This PR may also help my DefinitelyTyped/DefinitelyTyped#59700 (comment) to land. Thanks 👍 |
It's mongodb.Document instead of AnyObject now, to match CollectionBase.
|
Changes make sense to me. Only question for me is, does it have some backwards breaking? Or is mongodb.Document really just an AnyObject equivalent? |
|
Right now, mongodb has interface Document {
[key: string]: any
}and mongoose has interface AnyObject {
[k: string]: any
}So there's definitely no break right now. They're identical from the compiler's perspective. mongodb.Document might change in the future, but (1) I assume that's unlikely (2) it makes sense at a surface level that interfaces that extend mongodb types and functions that return mongodb types should use mongodb-based types instead of mongoose types. On (2), I don't know mongodb or mongoose, I just maintain Definitely Typed, so it's a guess on my part. |
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.
mongodb.Collection and mongodb.ChangeStream now both require that their type arguments
extend mongodb.Document. This requires adding this constraint in a few places.Fixes #11687