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

infiniteQueryOptions.ts

97 lines2.0 KB

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