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

query-options.ts

125 lines3.3 KB

1import type {
2 DataTag,
3 DefaultError,
4 InitialDataFunction,
5 QueryKey,
6} from '@tanstack/query-core'
7import type { CreateQueryOptions, NonUndefinedGuard } from './types'
8​
9/**
10 * @public
11 */
12export type UndefinedInitialDataOptions<
13 TQueryFnData = unknown,
14 TError = DefaultError,
15 TData = TQueryFnData,
16 TQueryKey extends QueryKey = QueryKey,
17> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
18 initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
20​
21/**
22 * @public
23 */
24export type DefinedInitialDataOptions<
25 TQueryFnData = unknown,
26 TError = DefaultError,
27 TData = TQueryFnData,
28 TQueryKey extends QueryKey = QueryKey,
29> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
30 initialData:
31 | NonUndefinedGuard<TQueryFnData>
32 | (() => NonUndefinedGuard<TQueryFnData>)
34​
35/**
36 * Allows to share and re-use query options in a type-safe way.
37 *
38 * The `queryKey` will be tagged with the type from `queryFn`.
39 *
40 * **Example**
41 *
42 * ```ts
43 * const { queryKey } = queryOptions({
44 * queryKey: ['key'],
45 * queryFn: () => Promise.resolve(5),
46 * // ^? Promise<number>
47 * })
48 *
49 * const queryClient = new QueryClient()
50 * const data = queryClient.getQueryData(queryKey)
51 * // ^? number | undefined
52 * ```
53 * @param options - The query options to tag with the type from `queryFn`.
54 * @returns The tagged query options.
55 * @public
56 */
57export function queryOptions<
58 TQueryFnData = unknown,
59 TError = DefaultError,
60 TData = TQueryFnData,
61 TQueryKey extends QueryKey = QueryKey,
62>(
63 options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
64): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
65 queryKey: DataTag<TQueryKey, TQueryFnData>
67​
68/**
69 * Allows to share and re-use query options in a type-safe way.
70 *
71 * The `queryKey` will be tagged with the type from `queryFn`.
72 *
73 * **Example**
74 *
75 * ```ts
76 * const { queryKey } = queryOptions({
77 * queryKey: ['key'],
78 * queryFn: () => Promise.resolve(5),
79 * // ^? Promise<number>
80 * })
81 *
82 * const queryClient = new QueryClient()
83 * const data = queryClient.getQueryData(queryKey)
84 * // ^? number | undefined
85 * ```
86 * @param options - The query options to tag with the type from `queryFn`.
87 * @returns The tagged query options.
88 * @public
89 */
90export function queryOptions<
91 TQueryFnData = unknown,
92 TError = DefaultError,
93 TData = TQueryFnData,
94 TQueryKey extends QueryKey = QueryKey,
95>(
96 options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
97): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
98 queryKey: DataTag<TQueryKey, TQueryFnData>
100​
101/**
102 * Allows to share and re-use query options in a type-safe way.
103 *
104 * The `queryKey` will be tagged with the type from `queryFn`.
105 *
106 * **Example**
107 *
108 * ```ts
109 * const { queryKey } = queryOptions({
110 * queryKey: ['key'],
111 * queryFn: () => Promise.resolve(5),
112 * // ^? Promise<number>
113 * })
114 *
115 * const queryClient = new QueryClient()
116 * const data = queryClient.getQueryData(queryKey)
117 * // ^? number | undefined
118 * ```
119 * @param options - The query options to tag with the type from `queryFn`.
120 * @returns The tagged query options.
121 * @public
122 */
123export function queryOptions(options: unknown) {
124 return options