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

types.ts

200 lines5.5 KB

1/* istanbul ignore file */
2​
3import type {
4 DefaultError,
5 DefinedInfiniteQueryObserverResult,
6 DefinedQueryObserverResult,
7 InfiniteQueryObserverResult,
8 MutateFunction,
9 MutationObserverOptions,
10 MutationObserverResult,
11 OmitKeyof,
12 Override,
13 QueryKey,
14 QueryObserverResult,
15} from '@tanstack/query-core'
16import type {
17 InfiniteQueryObserverOptions,
18 QueryObserverOptions,
19} from './QueryClient'
20import type { Accessor } from 'solid-js'
21​
22export interface UseBaseQueryOptions<
23 TQueryFnData = unknown,
24 TError = DefaultError,
25 TData = TQueryFnData,
26 TQueryData = TQueryFnData,
27 TQueryKey extends QueryKey = QueryKey,
28> extends OmitKeyof<
29 QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
30 'suspense'
31 > {
32 /**
33 * Only applicable while rendering queries on the server with streaming.
34 * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
35 * This can be useful to avoid sending a loading state to the client before the query has resolved.
36 * Defaults to `false`.
37 */
38 deferStream?: boolean
39 /**
40 * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
41 * The `data` property on useQuery is a SolidJS resource and will automatically suspend when the data is loading.
42 * Setting `suspense` to `false` will be a no-op.
43 */
44 suspense?: boolean
46​
47export interface SolidQueryOptions<
48 TQueryFnData = unknown,
49 TError = DefaultError,
50 TData = TQueryFnData,
51 TQueryKey extends QueryKey = QueryKey,
52> extends UseBaseQueryOptions<
53 TQueryFnData,
54 TError,
55 TData,
56 TQueryFnData,
57 TQueryKey
58 > {}
59​
60export type UseQueryOptions<
61 TQueryFnData = unknown,
62 TError = DefaultError,
63 TData = TQueryFnData,
64 TQueryKey extends QueryKey = QueryKey,
65> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>
66​
67/* --- Create Query and Create Base Query Types --- */
68​
69export type UseBaseQueryResult<
70 TData = unknown,
71 TError = DefaultError,
72> = QueryObserverResult<TData, TError>
73​
74export type UseQueryResult<
75 TData = unknown,
76 TError = DefaultError,
77> = UseBaseQueryResult<TData, TError>
78​
79export type DefinedUseBaseQueryResult<
80 TData = unknown,
81 TError = DefaultError,
82> = DefinedQueryObserverResult<TData, TError>
83​
84export type DefinedUseQueryResult<
85 TData = unknown,
86 TError = DefaultError,
87> = DefinedUseBaseQueryResult<TData, TError>
88​
89/* --- Create Infinite Queries Types --- */
90export interface SolidInfiniteQueryOptions<
91 TQueryFnData = unknown,
92 TError = DefaultError,
93 TData = TQueryFnData,
94 TQueryKey extends QueryKey = QueryKey,
95 TPageParam = unknown,
96> extends OmitKeyof<
97 InfiniteQueryObserverOptions<
98 TQueryFnData,
99 TError,
100 TData,
101 TQueryKey,
102 TPageParam
103 >,
104 'queryKey' | 'suspense'
105 > {
106 queryKey: TQueryKey
107 /**
108 * Only applicable while rendering queries on the server with streaming.
109 * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
110 * This can be useful to avoid sending a loading state to the client before the query has resolved.
111 * Defaults to `false`.
112 */
113 deferStream?: boolean
114 /**
115 * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
116 * The `data` property on useInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
117 * Setting `suspense` to `false` will be a no-op.
118 */
119 suspense?: boolean
121​
122export type UseInfiniteQueryOptions<
123 TQueryFnData = unknown,
124 TError = DefaultError,
125 TData = TQueryFnData,
126 TQueryKey extends QueryKey = QueryKey,
127 TPageParam = unknown,
128> = Accessor<
129 SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
131​
132export type UseInfiniteQueryResult<
133 TData = unknown,
134 TError = DefaultError,
135> = InfiniteQueryObserverResult<TData, TError>
136​
137export type DefinedUseInfiniteQueryResult<
138 TData = unknown,
139 TError = DefaultError,
140> = DefinedInfiniteQueryObserverResult<TData, TError>
141​
142/* --- Create Mutation Types --- */
143export interface SolidMutationOptions<
144 TData = unknown,
145 TError = DefaultError,
146 TVariables = void,
147 TOnMutateResult = unknown,
148> extends OmitKeyof<
149 MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>,
150 '_defaulted'
151 > {}
152​
153export type UseMutationOptions<
154 TData = unknown,
155 TError = DefaultError,
156 TVariables = void,
157 TOnMutateResult = unknown,
158> = Accessor<SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>>
159​
160export type UseMutateFunction<
161 TData = unknown,
162 TError = DefaultError,
163 TVariables = void,
164 TOnMutateResult = unknown,
165> = (
166 ...args: Parameters<
167 MutateFunction<TData, TError, TVariables, TOnMutateResult>
168 >
169) => void
170​
171export type UseMutateAsyncFunction<
172 TData = unknown,
173 TError = DefaultError,
174 TVariables = void,
175 TOnMutateResult = unknown,
176> = MutateFunction<TData, TError, TVariables, TOnMutateResult>
177​
178export type UseBaseMutationResult<
179 TData = unknown,
180 TError = DefaultError,
181 TVariables = unknown,
182 TOnMutateResult = unknown,
183> = Override<
184 MutationObserverResult<TData, TError, TVariables, TOnMutateResult>,
185 { mutate: UseMutateFunction<TData, TError, TVariables, TOnMutateResult> }
186> & {
187 mutateAsync: UseMutateAsyncFunction<
188 TData,
189 TError,
190 TVariables,
191 TOnMutateResult
192 >
194​
195export type UseMutationResult<
196 TData = unknown,
197 TError = DefaultError,
198 TVariables = unknown,
199 TOnMutateResult = unknown,
200> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>