Skip to content

Commit e674826

Browse files
DogPawHatcoderabbitai[bot]TkDodo
authored
React: update usePrefetchQuery to use new methods, plus react adaptor tests and docs (#10668)
* feat(react-query): update usePrefetchQuery to use new imperitive methods plus tests * docs(react-query): new docs for usePrefetchQuery * Update .changeset/warm-candies-like.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update packages/react-query/src/usePrefetchInfiniteQuery.tsx Co-authored-by: Dominik Dorfmeister 🔮 <[email protected]> * Update packages/react-query/src/usePrefetchQuery.tsx Co-authored-by: Dominik Dorfmeister 🔮 <[email protected]> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Dominik Dorfmeister 🔮 <[email protected]>
1 parent 4e48c58 commit e674826

11 files changed

Lines changed: 166 additions & 18 deletions

‎.changeset/warm-candies-like.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@tanstack/react-query': minor
3+
---
4+
5+
react-query: update usePrefetchQuery and usePrefetchInfiniteQuery to use queryClient.query and queryClient.infiniteQuery

‎docs/framework/react/reference/usePrefetchInfiniteQuery.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ usePrefetchInfiniteQuery(options)
99

1010
**Options**
1111

12-
You can pass everything to `usePrefetchInfiniteQuery` that you can pass to [`queryClient.prefetchInfiniteQuery`](../../../reference/QueryClient.md#queryclientprefetchinfinitequery). Remember that some of them are required as below:
12+
You can pass everything to `usePrefetchInfiniteQuery` that you can pass to [`queryClient.infiniteQuery`](../../../reference/QueryClient.md#queryclient-infinitequery). Remember that some of them are required as below:
1313

1414
- `queryKey: QueryKey`
1515
- **Required**

‎docs/framework/react/reference/usePrefetchQuery.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ usePrefetchQuery(options)
99

1010
**Options**
1111

12-
You can pass everything to `usePrefetchQuery` that you can pass to [`queryClient.prefetchQuery`](../../../reference/QueryClient.md#queryclientprefetchquery). Remember that some of them are required as below:
12+
You can pass everything to `usePrefetchQuery` that you can pass to [`queryClient.query`](../../../reference/QueryClient.md#queryclient-query). Remember that some of them are required as below:
1313

1414
- `queryKey: QueryKey`
1515
- **Required**
1616
- The query key to prefetch during render
1717

18-
- `queryFn: (context: QueryFunctionContext) => Promise<TData>`
18+
- `queryFn: (context: QueryFunctionContext<TQueryKey>) => TQueryFnData | Promise<TQueryFnData>`
1919
- **Required, but only if no default query function has been defined** See [Default Query Function](../guides/default-query-function.md) for more information.
2020

2121
**Returns**

‎packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,20 @@ describe('infiniteQueryOptions', () => {
6060
InfiniteData<string, unknown> | undefined
6161
>()
6262
})
63+
it('should work when passed to useInfiniteQuery with select', () => {
64+
const options = infiniteQueryOptions({
65+
queryKey: ['key'],
66+
queryFn: () => Promise.resolve('string'),
67+
getNextPageParam: () => 1,
68+
initialPageParam: 1,
69+
select: (data) => data.pages,
70+
})
71+
72+
const { data } = useInfiniteQuery(options)
73+
74+
// known issue: type of pageParams is unknown when returned from useInfiniteQuery
75+
expectTypeOf(data).toEqualTypeOf<Array<string> | undefined>()
76+
})
6377
it('should work when passed to useSuspenseInfiniteQuery', () => {
6478
const options = infiniteQueryOptions({
6579
queryKey: queryKey(),
@@ -72,6 +86,19 @@ describe('infiniteQueryOptions', () => {
7286

7387
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, unknown>>()
7488
})
89+
it('should work when passed to useSuspenseInfiniteQuery with select', () => {
90+
const options = infiniteQueryOptions({
91+
queryKey: ['key'],
92+
queryFn: () => Promise.resolve('string'),
93+
getNextPageParam: () => 1,
94+
initialPageParam: 1,
95+
select: (data) => data.pages,
96+
})
97+
98+
const { data } = useSuspenseInfiniteQuery(options)
99+
100+
expectTypeOf(data).toEqualTypeOf<Array<string>>()
101+
})
75102
it('should work when passed to infiniteQuery', async () => {
76103
const options = infiniteQueryOptions({
77104
queryKey: ['key'],
@@ -134,6 +161,19 @@ describe('infiniteQueryOptions', () => {
134161

135162
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, number>>()
136163
})
164+
it('should ignore select when passed to fetchInfiniteQuery', async () => {
165+
const options = infiniteQueryOptions({
166+
queryKey: ['key'],
167+
queryFn: () => Promise.resolve('string'),
168+
getNextPageParam: () => 1,
169+
initialPageParam: 1,
170+
select: (data) => data.pages,
171+
})
172+
173+
const data = await new QueryClient().fetchInfiniteQuery(options)
174+
175+
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, number>>()
176+
})
137177
it('should tag the queryKey with the result type of the QueryFn', () => {
138178
const { queryKey: tagged } = infiniteQueryOptions({
139179
queryKey: queryKey(),

‎packages/react-query/src/__tests__/queryOptions.test-d.tsx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,16 @@ describe('queryOptions', () => {
112112
const data = await new QueryClient().query(options)
113113
expectTypeOf(data).toEqualTypeOf<unknown>()
114114
})
115+
it('should ignore select when passed to fetchQuery', async () => {
116+
const options = queryOptions({
117+
queryKey: ['key'],
118+
queryFn: () => Promise.resolve(5),
119+
select: (data) => data.toString(),
120+
})
121+
122+
const data = await new QueryClient().fetchQuery(options)
123+
expectTypeOf(data).toEqualTypeOf<number>()
124+
})
115125
it('should work when passed to useQueries', () => {
116126
const options = queryOptions({
117127
queryKey: queryKey(),

‎packages/react-query/src/__tests__/useInfiniteQuery.test-d.tsx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,18 @@ describe('pageParam', () => {
3939
})
4040
})
4141

42+
it('initialPageParam should define type of param passed to queryFunctionContext for infiniteQuery', () => {
43+
const queryClient = new QueryClient()
44+
queryClient.infiniteQuery({
45+
queryKey: ['key'],
46+
queryFn: ({ pageParam }) => {
47+
expectTypeOf(pageParam).toEqualTypeOf<number>()
48+
return Promise.resolve(pageParam)
49+
},
50+
initialPageParam: 1,
51+
})
52+
})
53+
4254
it('initialPageParam should define type of param passed to queryFunctionContext for prefetchInfiniteQuery', () => {
4355
const queryClient = new QueryClient()
4456
queryClient.prefetchInfiniteQuery({

‎packages/react-query/src/__tests__/usePrefetchInfiniteQuery.test-d.tsx‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { assertType, describe, expectTypeOf, it } from 'vitest'
22
import { queryKey } from '@tanstack/query-test-utils'
3-
import { usePrefetchInfiniteQuery } from '..'
3+
import { skipToken, usePrefetchInfiniteQuery } from '..'
44

55
describe('usePrefetchInfiniteQuery', () => {
66
it('should return nothing', () => {
@@ -58,4 +58,25 @@ describe('usePrefetchInfiniteQuery', () => {
5858
}),
5959
)
6060
})
61+
62+
it('should not allow skipToken in queryFn', () => {
63+
assertType(
64+
usePrefetchInfiniteQuery({
65+
queryKey: queryKey(),
66+
// @ts-expect-error
67+
queryFn: skipToken,
68+
initialPageParam: 1,
69+
getNextPageParam: () => 1,
70+
}),
71+
)
72+
assertType(
73+
usePrefetchInfiniteQuery({
74+
queryKey: queryKey(),
75+
// @ts-expect-error
76+
queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5),
77+
initialPageParam: 1,
78+
getNextPageParam: () => 1,
79+
}),
80+
)
81+
})
6182
})

‎packages/react-query/src/__tests__/usePrefetchQuery.test-d.tsx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,16 @@ describe('usePrefetchQuery', () => {
5757
}),
5858
)
5959
})
60+
61+
it('should type queryFn and select data independently', () => {
62+
usePrefetchQuery<string, Error, number, { value: string }>({
63+
queryKey: queryKey(),
64+
queryFn: () => Promise.resolve('data'),
65+
select: (data) => {
66+
expectTypeOf(data).toEqualTypeOf<{ value: string }>()
67+
68+
return data.value.length
69+
},
70+
})
71+
})
6072
})

‎packages/react-query/src/types.ts‎

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ import type {
55
DefinedInfiniteQueryObserverResult,
66
DefinedQueryObserverResult,
77
DistributiveOmit,
8-
FetchQueryOptions,
98
InfiniteData,
9+
InfiniteQueryExecuteOptions,
1010
InfiniteQueryObserverOptions,
1111
InfiniteQueryObserverResult,
1212
MutateFunction,
1313
MutationObserverOptions,
1414
MutationObserverResult,
1515
OmitKeyof,
1616
Override,
17+
QueryExecuteOptions,
1718
QueryKey,
1819
QueryObserverOptions,
1920
QueryObserverResult,
@@ -47,17 +48,52 @@ export interface UseBaseQueryOptions<
4748
subscribed?: boolean
4849
}
4950

50-
export interface UsePrefetchQueryOptions<
51+
export type UsePrefetchQueryOptions<
5152
TQueryFnData = unknown,
5253
TError = DefaultError,
5354
TData = TQueryFnData,
55+
TQueryData = TQueryFnData,
5456
TQueryKey extends QueryKey = QueryKey,
55-
> extends OmitKeyof<
56-
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
57+
> = DistributiveOmit<
58+
QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
5759
'queryFn'
58-
> {
60+
> & {
61+
queryFn?: Exclude<
62+
QueryExecuteOptions<
63+
TQueryFnData,
64+
TError,
65+
TData,
66+
TQueryData,
67+
TQueryKey
68+
>['queryFn'],
69+
SkipToken
70+
>
71+
}
72+
73+
export type UsePrefetchInfiniteQueryOptions<
74+
TQueryFnData = unknown,
75+
TError = DefaultError,
76+
TData = InfiniteData<TQueryFnData>,
77+
TQueryKey extends QueryKey = QueryKey,
78+
TPageParam = unknown,
79+
> = DistributiveOmit<
80+
InfiniteQueryExecuteOptions<
81+
TQueryFnData,
82+
TError,
83+
TData,
84+
TQueryKey,
85+
TPageParam
86+
>,
87+
'queryFn'
88+
> & {
5989
queryFn?: Exclude<
60-
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
90+
InfiniteQueryExecuteOptions<
91+
TQueryFnData,
92+
TError,
93+
TData,
94+
TQueryKey,
95+
TPageParam
96+
>['queryFn'],
6197
SkipToken
6298
>
6399
}
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
1+
import { noop } from '@tanstack/query-core'
12
import { useQueryClient } from './QueryClientProvider'
3+
24
import type {
35
DefaultError,
4-
FetchInfiniteQueryOptions,
6+
InfiniteData,
57
QueryClient,
68
QueryKey,
79
} from '@tanstack/query-core'
10+
import type { UsePrefetchInfiniteQueryOptions } from './types'
811

912
export function usePrefetchInfiniteQuery<
1013
TQueryFnData = unknown,
1114
TError = DefaultError,
12-
TData = TQueryFnData,
15+
TData = InfiniteData<TQueryFnData>,
1316
TQueryKey extends QueryKey = QueryKey,
1417
TPageParam = unknown,
1518
>(
16-
options: FetchInfiniteQueryOptions<
19+
options: UsePrefetchInfiniteQueryOptions<
1720
TQueryFnData,
1821
TError,
1922
TData,
2023
TQueryKey,
2124
TPageParam
2225
>,
2326
queryClient?: QueryClient,
24-
) {
27+
): void {
2528
const client = useQueryClient(queryClient)
2629

2730
if (!client.getQueryState(options.queryKey)) {
28-
client.prefetchInfiniteQuery(options)
31+
void client.infiniteQuery(options).catch(noop)
2932
}
3033
}

0 commit comments

Comments
 (0)