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

infiniteQueryOptions.ts

94 lines2.1 KB

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