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

queryOptions.ts

50 lines1.5 KB

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