File size: 4,801 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
import type {
DataTag,
DefaultError,
InitialDataFunction,
NonUndefinedGuard,
OmitKeyof,
QueryFunction,
QueryKey,
SkipToken,
} from '@tanstack/query-core'
import type { CreateQueryOptions } from './types'
export type UndefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
initialData?:
| undefined
| InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
| NonUndefinedGuard<TQueryFnData>
}
export type UnusedSkipTokenOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = OmitKeyof<
CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
'queryFn'
> & {
queryFn?: Exclude<
CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
SkipToken | undefined
>
}
export type DefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = Omit<
CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
'queryFn'
> & {
initialData:
| NonUndefinedGuard<TQueryFnData>
| (() => NonUndefinedGuard<TQueryFnData>)
queryFn?: QueryFunction<TQueryFnData, TQueryKey>
}
/**
* Allows to share and re-use query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
* **Example**
*
* ```ts
* const { queryKey } = queryOptions({
* queryKey: ['key'],
* queryFn: () => Promise.resolve(5),
* // ^? Promise<number>
* })
*
* const queryClient = new QueryClient()
* const data = queryClient.getQueryData(queryKey)
* // ^? number | undefined
* ```
* @param options - The query options to tag with the type from `queryFn`.
* @returns The tagged query options.
* @public
*/
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
/**
* Allows to share and re-use query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
* **Example**
*
* ```ts
* const { queryKey } = queryOptions({
* queryKey: ['key'],
* queryFn: () => Promise.resolve(5),
* // ^? Promise<number>
* })
*
* const queryClient = new QueryClient()
* const data = queryClient.getQueryData(queryKey)
* // ^? number | undefined
* ```
* @param options - The query options to tag with the type from `queryFn`.
* @returns The tagged query options.
* @public
*/
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>,
): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
/**
* Allows to share and re-use query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
* **Example**
*
* ```ts
* const { queryKey } = queryOptions({
* queryKey: ['key'],
* queryFn: () => Promise.resolve(5),
* // ^? Promise<number>
* })
*
* const queryClient = new QueryClient()
* const data = queryClient.getQueryData(queryKey)
* // ^? number | undefined
* ```
* @param options - The query options to tag with the type from `queryFn`.
* @returns The tagged query options.
* @public
*/
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
/**
* Allows to share and re-use query options in a type-safe way.
*
* The `queryKey` will be tagged with the type from `queryFn`.
*
* **Example**
*
* ```ts
* const { queryKey } = queryOptions({
* queryKey: ['key'],
* queryFn: () => Promise.resolve(5),
* // ^? Promise<number>
* })
*
* const queryClient = new QueryClient()
* const data = queryClient.getQueryData(queryKey)
* // ^? number | undefined
* ```
* @param options - The query options to tag with the type from `queryFn`.
* @returns The tagged query options.
* @public
*/
export function queryOptions(options: unknown) {
return options
}
|