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

infiniteQueryOptions.ts

95 lines2.3 KB

1import type { UseInfiniteQueryOptions } from './types'
2import type {
3 InfiniteData,
4 NonUndefinedGuard,
5 OmitKeyof,
6 QueryKey,
7 WithRequired,
8} from '@tanstack/query-core'
9​
10type UseInfiniteQueryOptionsOmitted<
11 TQueryFnData = unknown,
12 TError = unknown,
13 TData = TQueryFnData,
14 TQueryKey extends QueryKey = QueryKey,
15> = OmitKeyof<
16 UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
17 'onSuccess' | 'onError' | 'onSettled' | 'refetchInterval'
19​
20type ProhibitedInfiniteQueryOptionsKeyInV5 = keyof Pick<
21 UseInfiniteQueryOptionsOmitted,
22 'useErrorBoundary' | 'suspense'
24​
25export type UndefinedInitialDataInfiniteOptions<
26 TQueryFnData,
27 TError = unknown,
28 TData = TQueryFnData,
29 TQueryKey extends QueryKey = QueryKey,
30> = UseInfiniteQueryOptionsOmitted<TQueryFnData, TError, TData, TQueryKey> & {
31 initialData?: undefined
33​
34export type DefinedInitialDataInfiniteOptions<
35 TQueryFnData,
36 TError = unknown,
37 TData = TQueryFnData,
38 TQueryKey extends QueryKey = QueryKey,
39> = UseInfiniteQueryOptionsOmitted<TQueryFnData, TError, TData, TQueryKey> & {
40 initialData:
41 | NonUndefinedGuard<InfiniteData<TQueryFnData>>
42 | (() => NonUndefinedGuard<InfiniteData<TQueryFnData>>)
43 | undefined
45​
46export function infiniteQueryOptions<
47 TQueryFnData,
48 TError = unknown,
49 TData = TQueryFnData,
50 TQueryKey extends QueryKey = QueryKey,
51>(
52 options: WithRequired<
53 OmitKeyof<
54 DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>,
55 ProhibitedInfiniteQueryOptionsKeyInV5
56 >,
57 'queryKey'
58 >,
59): WithRequired<
60 OmitKeyof<
61 DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>,
62 ProhibitedInfiniteQueryOptionsKeyInV5
63 >,
64 'queryKey'
66​
67export function infiniteQueryOptions<
68 TQueryFnData,
69 TError = unknown,
70 TData = TQueryFnData,
71 TQueryKey extends QueryKey = QueryKey,
72>(
73 options: WithRequired<
74 OmitKeyof<
75 UndefinedInitialDataInfiniteOptions<
76 TQueryFnData,
77 TError,
78 TData,
79 TQueryKey
80 >,
81 ProhibitedInfiniteQueryOptionsKeyInV5
82 >,
83 'queryKey'
84 >,
85): WithRequired<
86 OmitKeyof<
87 UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>,
88 ProhibitedInfiniteQueryOptionsKeyInV5
89 >,
90 'queryKey'
92​
93export function infiniteQueryOptions(options: unknown) {
94 return options