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

queryOptions.ts

87 lines2.4 KB

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