types(query): allow assigning QueryFilter<DocType> to QueryFilter<any>#16020
Merged
types(query): allow assigning QueryFilter<DocType> to QueryFilter<any>#16020
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts Mongoose’s TypeScript query filter typings so that QueryFilter<DocType> (including document types with non-ObjectId _id, like string) is assignable to places that accept QueryFilter<any> (notably aggregation $match), addressing #16006.
Changes:
- Introduces a “looser
_id” variant forQueryFilter<any>to avoidmongodb.WithId<any>forcing_id: ObjectId. - Removes a duplicate
UUIDToJSONtype definition intypes/index.d.ts. - Adds a type-level regression case covering
$matchacceptingQueryFilterfor a document withstring_id.
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
types/query.d.ts |
Adjusts the QueryFilter<any> fallback to avoid _id being forced to ObjectId, improving assignability. |
types/index.d.ts |
Removes a duplicate UUIDToJSON type definition, leaving the canonical alias-based definition. |
test/types/PipelineStage.test.ts |
Adds a compile-time regression case for #16006 using $match with QueryFilter<MyDoc> where _id: string. |
hasezoey
approved these changes
Feb 11, 2026
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
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 #16006
Summary
The problem in #16006 is that
WithId<>inQueryFilter<any>makesQueryFilter<any>act like a query filter with_id: ObjectId, which is potentially problematic because you would intuitively assume thatQueryFilter<{ _id: string }>is assignable toQueryFilter<any>.I also removed a duplicate
UUIDToJSONdefinitionExamples