Open History to see the last commit
1import type {
2 DataTag,
3 DefaultError,
4 InitialDataFunction,
5 OmitKeyof,
6 QueryFunction,
7 QueryKey,
8 SkipToken,
9} from '@tanstack/query-core'
10import type { UseQueryOptions } from './types'
11β
12export type UndefinedInitialDataOptions<
13 TQueryFnData = unknown,
14 TError = DefaultError,
15 TData = TQueryFnData,
16 TQueryKey extends QueryKey = QueryKey,
17> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
18 initialData?:
19 | undefined
20 | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
21 | NonUndefinedGuard<TQueryFnData>
22}
23β
24export type UnusedSkipTokenOptions<
25 TQueryFnData = unknown,
26 TError = DefaultError,
27 TData = TQueryFnData,
28 TQueryKey extends QueryKey = QueryKey,
29> = OmitKeyof<
30 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
31 'queryFn'
32> & {
33 queryFn?: Exclude<
34 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
35 SkipToken | undefined
36 >
37}
38β
39type NonUndefinedGuard<T> = T extends undefined ? never : T
40β
41export type DefinedInitialDataOptions<
42 TQueryFnData = unknown,
43 TError = DefaultError,
44 TData = TQueryFnData,
45 TQueryKey extends QueryKey = QueryKey,
46> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
47 initialData:
48 | NonUndefinedGuard<TQueryFnData>
49 | (() => NonUndefinedGuard<TQueryFnData>)
50 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
51}
52β
53export function queryOptions<
54 TQueryFnData = unknown,
55 TError = DefaultError,
56 TData = TQueryFnData,
57 TQueryKey extends QueryKey = QueryKey,
58>(
59 options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
60): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
61 queryKey: DataTag<TQueryKey, TQueryFnData, TError>
62}
63β
64export function queryOptions<
65 TQueryFnData = unknown,
66 TError = DefaultError,
67 TData = TQueryFnData,
68 TQueryKey extends QueryKey = QueryKey,
69>(
70 options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>,
71): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & {
72 queryKey: DataTag<TQueryKey, TQueryFnData, TError>
73}
74β
75export function queryOptions<
76 TQueryFnData = unknown,
77 TError = DefaultError,
78 TData = TQueryFnData,
79 TQueryKey extends QueryKey = QueryKey,
80>(
81 options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
82): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
83 queryKey: DataTag<TQueryKey, TQueryFnData, TError>
84}
85β
86export function queryOptions(options: unknown) {
87 return options
88}