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

queryOptions.ts

92 lines2.3 KB

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