BREAKING CHANGE: make FilterQuery properties no longer resolve to any in TypeScript
#15422
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements a breaking change that updates FilterQuery types in TypeScript so that query properties no longer default to any, improving IntelliSense support for query operators.
- Updated type tests in test/types/queries.test.ts to include explicit cast usage for FilterQuery.
- Added a workaround cast in the findById function (gh14510) to handle stricter typing.
- Minor updates in test/query.test.js to support the overall changes.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/types/queries.test.ts | Added explicit casts for FilterQuery in type tests and gh14510 function update |
| test/query.test.js | Minor test update for findById behavior confirmation |
hasezoey
added
backwards-breaking
typescript
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.
Summary
Right now
FilterQuerytypes resolve toanyfor any query properties, which means query operators like $gt etc don't show up in intellisense (re: #15406). Making this change would break #14473, but that's an easy workaround - just add anas.Bring back the changes reverted by #14510 - I think the benefit of autocomplete outweighs the friction of adding an
aswhen you're using a pattern that you're not supposed to in TypeScript (at least according to https://stackoverflow.com/questions/56505560/how-to-fix-ts2322-could-be-instantiated-with-a-different-subtype-of-constraint).Examples