Open History to see the last commit
1'use client'
2import { InfiniteQueryObserver, parseQueryArgs } from '@tanstack/query-core'
3import { useBaseQuery } from './useBaseQuery'
4import type {
5 InfiniteData,
6 NonUndefinedGuard,
7 QueryFunction,
8 QueryKey,
9 QueryObserver,
10} from '@tanstack/query-core'
11import type {
12 DefinedUseInfiniteQueryResult,
13 UseInfiniteQueryOptions,
14 UseInfiniteQueryResult,
15} from './types'
16β
17// HOOK
18β
19export function useInfiniteQuery<
20 TQueryFnData = unknown,
21 TError = unknown,
22 TData = TQueryFnData,
23 TQueryKey extends QueryKey = QueryKey,
24>(
25 options: UseInfiniteQueryOptions<
26 TQueryFnData,
27 TError,
28 TData,
29 TQueryFnData,
30 TQueryKey
31 > & {
32 initialData:
33 | NonUndefinedGuard<InfiniteData<TQueryFnData>>
34 | (() => NonUndefinedGuard<InfiniteData<TQueryFnData>>)
35 | undefined
36 },
37): DefinedUseInfiniteQueryResult<TData, TError>
38export function useInfiniteQuery<
39 TQueryFnData = unknown,
40 TError = unknown,
41 TData = TQueryFnData,
42 TQueryKey extends QueryKey = QueryKey,
43>(
44 options: UseInfiniteQueryOptions<
45 TQueryFnData,
46 TError,
47 TData,
48 TQueryFnData,
49 TQueryKey
50 >,
51): UseInfiniteQueryResult<TData, TError>
52/** @deprecated This function overload will be removed in the next major version. */
53export function useInfiniteQuery<
54 TQueryFnData = unknown,
55 TError = unknown,
56 TData = TQueryFnData,
57 TQueryKey extends QueryKey = QueryKey,
58>(
59 queryKey: TQueryKey,
60 options?: Omit<
61 UseInfiniteQueryOptions<
62 TQueryFnData,
63 TError,
64 TData,
65 TQueryFnData,
66 TQueryKey
67 >,
68 'queryKey'
69 >,
70): UseInfiniteQueryResult<TData, TError>
71/** @deprecated This function overload will be removed in the next major version. */
72export function useInfiniteQuery<
73 TQueryFnData = unknown,
74 TError = unknown,
75 TData = TQueryFnData,
76 TQueryKey extends QueryKey = QueryKey,
77>(
78 queryKey: TQueryKey,
79 queryFn: QueryFunction<TQueryFnData, TQueryKey>,
80 options?: Omit<
81 UseInfiniteQueryOptions<
82 TQueryFnData,
83 TError,
84 TData,
85 TQueryFnData,
86 TQueryKey
87 >,
88 'queryKey' | 'queryFn'
89 >,
90): UseInfiniteQueryResult<TData, TError>
91export function useInfiniteQuery<
92 TQueryFnData,
93 TError,
94 TData = TQueryFnData,
95 TQueryKey extends QueryKey = QueryKey,
96>(
97 arg1:
98 | TQueryKey
99 | UseInfiniteQueryOptions<
100 TQueryFnData,
101 TError,
102 TData,
103 TQueryFnData,
104 TQueryKey
105 >,
106 arg2?:
107 | QueryFunction<TQueryFnData, TQueryKey>
108 | UseInfiniteQueryOptions<
109 TQueryFnData,
110 TError,
111 TData,
112 TQueryFnData,
113 TQueryKey
114 >,
115 arg3?: UseInfiniteQueryOptions<
116 TQueryFnData,
117 TError,
118 TData,
119 TQueryFnData,
120 TQueryKey
121 >,
122): UseInfiniteQueryResult<TData, TError> {
123 const options = parseQueryArgs(arg1, arg2, arg3)
124 return useBaseQuery(
125 options,
126 InfiniteQueryObserver as typeof QueryObserver,
127 ) as UseInfiniteQueryResult<TData, TError>
128}