Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

infiniteQueryOptions.ts

149 lines3.1 KB

1import type {
2 DataTag,
3 DefaultError,
4 InfiniteData,
5 InitialDataFunction,
6 NonUndefinedGuard,
7 OmitKeyof,
8 QueryKey,
9 SkipToken,
10} from '@tanstack/query-core'
11import type { UseInfiniteQueryOptions } from './types'
12​
13export type UndefinedInitialDataInfiniteOptions<
14 TQueryFnData,
15 TError = DefaultError,
16 TData = InfiniteData<TQueryFnData>,
17 TQueryKey extends QueryKey = QueryKey,
18 TPageParam = unknown,
19> = UseInfiniteQueryOptions<
20 TQueryFnData,
21 TError,
22 TData,
23 TQueryKey,
24 TPageParam
25> & {
26 initialData?:
27 | undefined
28 | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
29 | InitialDataFunction<
30 NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
31 >
33​
34export type UnusedSkipTokenInfiniteOptions<
35 TQueryFnData,
36 TError = DefaultError,
37 TData = InfiniteData<TQueryFnData>,
38 TQueryKey extends QueryKey = QueryKey,
39 TPageParam = unknown,
40> = OmitKeyof<
41 UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
42 'queryFn'
43> & {
44 queryFn?: Exclude<
45 UseInfiniteQueryOptions<
46 TQueryFnData,
47 TError,
48 TData,
49 TQueryKey,
50 TPageParam
51 >['queryFn'],
52 SkipToken | undefined
53 >
55​
56export type DefinedInitialDataInfiniteOptions<
57 TQueryFnData,
58 TError = DefaultError,
59 TData = InfiniteData<TQueryFnData>,
60 TQueryKey extends QueryKey = QueryKey,
61 TPageParam = unknown,
62> = UseInfiniteQueryOptions<
63 TQueryFnData,
64 TError,
65 TData,
66 TQueryKey,
67 TPageParam
68> & {
69 initialData:
70 | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
71 | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
72 | undefined
74​
75export function infiniteQueryOptions<
76 TQueryFnData,
77 TError = DefaultError,
78 TData = InfiniteData<TQueryFnData>,
79 TQueryKey extends QueryKey = QueryKey,
80 TPageParam = unknown,
81>(
82 options: DefinedInitialDataInfiniteOptions<
83 TQueryFnData,
84 TError,
85 TData,
86 TQueryKey,
87 TPageParam
88 >,
89): DefinedInitialDataInfiniteOptions<
90 TQueryFnData,
91 TError,
92 TData,
93 TQueryKey,
94 TPageParam
95> & {
96 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
98​
99export function infiniteQueryOptions<
100 TQueryFnData,
101 TError = DefaultError,
102 TData = InfiniteData<TQueryFnData>,
103 TQueryKey extends QueryKey = QueryKey,
104 TPageParam = unknown,
105>(
106 options: UnusedSkipTokenInfiniteOptions<
107 TQueryFnData,
108 TError,
109 TData,
110 TQueryKey,
111 TPageParam
112 >,
113): UnusedSkipTokenInfiniteOptions<
114 TQueryFnData,
115 TError,
116 TData,
117 TQueryKey,
118 TPageParam
119> & {
120 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
122​
123export function infiniteQueryOptions<
124 TQueryFnData,
125 TError = DefaultError,
126 TData = InfiniteData<TQueryFnData>,
127 TQueryKey extends QueryKey = QueryKey,
128 TPageParam = unknown,
129>(
130 options: UndefinedInitialDataInfiniteOptions<
131 TQueryFnData,
132 TError,
133 TData,
134 TQueryKey,
135 TPageParam
136 >,
137): UndefinedInitialDataInfiniteOptions<
138 TQueryFnData,
139 TError,
140 TData,
141 TQueryKey,
142 TPageParam
143> & {
144 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
146​
147export function infiniteQueryOptions(options: unknown) {
148 return options