Add types for QueryFilters which flow down to Query<> and QueryKey/DataTag types #8332
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
3 tasks
TkDodo
reviewed
Nov 23, 2024
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 03ab3e3. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
Done Good I'm doing this. I think getQueryState could be next on my agenda, DataTag has no way to communicate an error type but getQueryState can get you back the error. I've left a test with a comment for now to document the current behaviour |
TkDodo
approved these changes
Nov 26, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8332 +/- ##
===========================================
+ Coverage 45.97% 62.90% +16.93%
===========================================
Files 200 136 -64
Lines 7509 4799 -2710
Branches 1718 1345 -373
===========================================
- Hits 3452 3019 -433
+ Misses 3680 1540 -2140
+ Partials 377 240 -137 |
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.
At tRPC we're working on a new react query client which only provides factories to React Query interfaces. Many of these factories already support full type-safety, for instance a QueryKey can have a DataTag which hints at the query data type.
QueryKey (with DataTag) and Query<> both support typesafety, but QueryFilters hides this and only exposes the defaults. This means our queryFilter factory method cannot be type-safe without replicating the tanstack query types into the tRPC codebase.
I propose upstreaming this type-safety so that everyone can benefit and tRPC can utilise it natively
Here is the work I'm doing on the tRPC side: trpc/trpc#6265