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

queryOptions.ts

55 lines1.6 KB

1import type {
2 DataTag,
3 DefaultError,
4 InitialDataFunction,
5 QueryKey,
6} from '@tanstack/query-core'
7import type { UseQueryOptions } from './types'
8​
9export type UndefinedInitialDataOptions<
10 TQueryFnData = unknown,
11 TError = DefaultError,
12 TData = TQueryFnData,
13 TQueryKey extends QueryKey = QueryKey,
14> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
15 initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
17​
18type NonUndefinedGuard<T> = T extends undefined ? never : T
19​
20export type DefinedInitialDataOptions<
21 TQueryFnData = unknown,
22 TError = DefaultError,
23 TData = TQueryFnData,
24 TQueryKey extends QueryKey = QueryKey,
25> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
26 initialData:
27 | NonUndefinedGuard<TQueryFnData>
28 | (() => NonUndefinedGuard<TQueryFnData>)
30​
31export function queryOptions<
32 TQueryFnData = unknown,
33 TError = DefaultError,
34 TData = TQueryFnData,
35 TQueryKey extends QueryKey = QueryKey,
36>(
37 options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
38): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
39 queryKey: DataTag<TQueryKey, TQueryFnData>
41​
42export function queryOptions<
43 TQueryFnData = unknown,
44 TError = DefaultError,
45 TData = TQueryFnData,
46 TQueryKey extends QueryKey = QueryKey,
47>(
48 options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
49): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
50 queryKey: DataTag<TQueryKey, TQueryFnData>
52​
53export function queryOptions(options: unknown) {
54 return options