refactor: improve type safety in getQueryData by using generics
#9218
+2
−3
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
Refactored the `getQueryData` method in `QueryClient` to use generics for type inference instead of type assertion with `as`.
The previous implementation of `getQueryData` relied on a type assertion (`as`) to cast the result of `queryCache.get()`:
```typescript
return this.#queryCache.get(options.queryHash)?.state.data as
| TInferredQueryFnData
| undefined
```
While this works, using generics is a more type-safe and idiomatic approach in TypeScript. It allows the type system to infer the correct type for `TInferredQueryFnData` when `queryCache.get` is called, reducing the need for manual type casting and potential runtime errors if the cast is incorrect.
## Changes
The `getQueryData` method has been updated to pass `TInferredQueryFnData` as a generic type argument to `this.#queryCache.get()`:
**Before:**
```typescript
return this.#queryCache.get(options.queryHash)?.state.data as
| TInferredQueryFnData
| undefined
```
**After:**
```typescript
return this.#queryCache.get<TInferredQueryFnData>(options.queryHash)?.state
.data
```
This change leverages the existing generic type parameter `TInferredQueryFnData` already defined in the `getQueryData` signature and `QueryCache#get` method.
|
View your CI Pipeline Execution ↗ for commit 1b78c8b.
☁️ Nx Cloud last updated this comment at |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9218 +/- ##
===========================================
+ Coverage 45.30% 59.63% +14.32%
===========================================
Files 209 138 -71
Lines 8257 5495 -2762
Branches 1856 1471 -385
===========================================
- Hits 3741 3277 -464
+ Misses 4076 1921 -2155
+ Partials 440 297 -143 🚀 New features to boost your workflow:
|
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.
Refactored the
getQueryDatamethod inQueryClientto use generics for type inference instead of type assertion withas.The previous implementation of
getQueryDatarelied on a type assertion (as) to cast the result ofqueryCache.get():While this works, using generics is a more type-safe and idiomatic approach in TypeScript. It allows the type system to infer the correct type for
TInferredQueryFnDatawhenqueryCache.getis called, reducing the need for manual type casting and potential runtime errors if the cast is incorrect.Changes
The
getQueryDatamethod has been updated to passTInferredQueryFnDataas a generic type argument tothis.#queryCache.get():Before:
After:
This change leverages the existing generic type parameter
TInferredQueryFnDataalready defined in thegetQueryDatasignature andQueryCache#getmethod.