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

injectQuery.md

354 lines23.8 KB

1---
2id: injectQuery
3title: injectQuery
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8## Overview
9​
10```ts
11function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): DefinedCreateQueryResult<TData, TError>;
12function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): CreateQueryResult<TData, TError>;
13function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): CreateQueryResult<TData, TError>;
14```
15​
16- [`() => DefinedInitialDataOptions` β†’ `DefinedCreateQueryResult`](#call-signature-1): This overload is selected when `initialData` is known to be defined on the options returned by `injectQueryFn`, so the resulting `data` signal is never `undefined` (unless a `select` changes `TData` to include `undefined`).
17- [`() => UndefinedInitialDataOptions` β†’ `CreateQueryResult`](#call-signature-2): Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
18- [`() => CreateQueryOptions` β†’ `CreateQueryResult`](#call-signature-3): This overload accepts the general [CreateQueryOptions](../interfaces/CreateQueryOptions.md) shape rather than the `initialData`-aware overloads above, so whether `data` is defined can't be inferred from the call site β€” useful when wrapping `injectQuery` in your own helper function that forwards caller-provided options.
19​
20See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
21​
22<a id="call-signature-1"></a>
23​
24## Call Signature
25​
26```ts
27function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): DefinedCreateQueryResult<TData, TError>;
28```
29​
30Defined in: [packages/angular-query-experimental/src/inject-query.ts:72](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L72)
31​
32This overload is selected when `initialData` is known to be defined on the options returned by
33`injectQueryFn`, so the resulting `data` signal is never `undefined` (unless a `select` changes `TData` to
34include `undefined`).
35​
36### Type Parameters
37​
38#### TQueryFnData
39​
40`TQueryFnData` = `unknown`
41​
42#### TError
43​
44`TError` = `Error`
45​
46#### TData
47​
48`TData` = `TQueryFnData`
49​
50#### TQueryKey
51​
52`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
53​
54### Parameters
55​
56#### injectQueryFn
57​
58() => [`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
59​
60A function returning the [DefinedInitialDataOptions](../type-aliases/DefinedInitialDataOptions.md) to use β€” everything you
61can pass to `injectQuery`, with `initialData` known to be defined. Similar to `computed` from Angular, this
62function runs in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive the
63query.
64​
65#### options?
66​
67[`InjectQueryOptions`](../interfaces/InjectQueryOptions.md)
68​
69Additional configuration
70​
71### Returns
72​
73[`DefinedCreateQueryResult`](../type-aliases/DefinedCreateQueryResult.md)\<`TData`, `TError`\>
74​
75The query result, typed so that `data` is never `undefined` (unless a `select` changes `TData` to
76include `undefined`).
77​
78### See
79​
80 - https://tanstack.com/query/latest/docs/framework/angular/guides/queries
81 - [queryOptions](queryOptions.md) to share these options between `injectQuery` and imperative APIs like
82`queryClient.fetchQuery`.
83​
84### Example
85​
86```angular-ts
87@Component({
88 selector: 'posts',
89 template: `
90 <!-- `postsQuery.data()` is `Post[]`, never `undefined`, thanks to `initialData` β€” even if a
91 refetch fails, so the list stays visible alongside the error. -->
92 @if (postsQuery.isError()) {
93 <span>Error: {{ postsQuery.error()?.message }}</span>
94 }
95 <ul>
96 @for (post of postsQuery.data(); track post.id) {
97 <li>{{ post.title }}</li>
98 }
99 </ul>
100 `,
101})
102export class Posts {
103 readonly postsQuery = injectQuery(() => ({
104 queryKey: ['posts'],
105 queryFn: fetchPosts,
106 initialData: [],
107 }))
109```
110​
111<a id="call-signature-2"></a>
112​
113## Call Signature
114​
115```ts
116function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): CreateQueryResult<TData, TError>;
117```
118​
119Defined in: [packages/angular-query-experimental/src/inject-query.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L158)
120​
121Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
122​
123### Type Parameters
124​
125#### TQueryFnData
126​
127`TQueryFnData` = `unknown`
128​
129#### TError
130​
131`TError` = `Error`
132​
133#### TData
134​
135`TData` = `TQueryFnData`
136​
137#### TQueryKey
138​
139`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
140​
141### Parameters
142​
143#### injectQueryFn
144​
145() => [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
146​
147A function returning the [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything
148you can pass to `injectQuery`. Similar to `computed` from Angular, this function runs in the reactive
149context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive the query.
150​
151#### options?
152​
153[`InjectQueryOptions`](../interfaces/InjectQueryOptions.md)
154​
155Additional configuration
156​
157### Returns
158​
159[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
160​
161The query result. `status()` is `'pending'` if there is no cached data to display, `'error'` if
162the last fetch attempt failed, or `'success'` if the query has data to display. `isPending`/`isSuccess`/
163`isError` are type-guard methods for convenience.
164​
165### See
166​
167 - https://tanstack.com/query/latest/docs/framework/angular/guides/queries
168 - [queryOptions](queryOptions.md) to share these options between `injectQuery` and imperative APIs like
169`queryClient.fetchQuery`.
170​
171### Examples
172​
173```angular-ts
174@Component({
175 selector: 'posts',
176 template: `
177 @if (postsQuery.isPending()) {
178 Loading...
179 } @else if (postsQuery.isError()) {
180 <span>Error: {{ postsQuery.error()?.message }}</span>
181 } @else {
182 <ul>
183 @for (post of postsQuery.data(); track post.id) {
184 <li>{{ post.title }}</li>
185 }
186 </ul>
187 }
188 `,
189})
190export class Posts {
191 readonly postsQuery = injectQuery(() => ({
192 queryKey: ['posts'],
193 queryFn: fetchPosts,
194 }))
196```
197​
198Similar to `computed` from Angular, the function passed to `injectQuery` runs in the reactive context. In
199the example below, the query is automatically enabled and executed when the filter signal changes to a
200truthy value. When the filter signal changes back to a falsy value, the query is disabled.
201```angular-ts
202@Component({
203 selector: 'posts',
204 template: `
205 <input [ngModel]="filter()" (ngModelChange)="filter.set($event)" />
206 @if (postsQuery.isPending()) {
207 Loading...
208 } @else if (postsQuery.isError()) {
209 <span>Error: {{ postsQuery.error()?.message }}</span>
210 } @else {
211 <ul>
212 @for (post of postsQuery.data(); track post.id) {
213 <li>{{ post.title }}</li>
214 }
215 </ul>
216 }
217 `,
218})
219export class Posts {
220 readonly filter = signal('')
221​
222 readonly postsQuery = injectQuery(() => ({
223 queryKey: ['posts', this.filter()],
224 queryFn: () => fetchPosts(this.filter()),
225 // Signals can be combined with expressions
226 enabled: !!this.filter(),
227 }))
229```
230​
231<a id="call-signature-3"></a>
232​
233## Call Signature
234​
235```ts
236function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(injectQueryFn: () => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, options?: InjectQueryOptions): CreateQueryResult<TData, TError>;
237```
238​
239Defined in: [packages/angular-query-experimental/src/inject-query.ts:184](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L184)
240​
241This overload accepts the general [CreateQueryOptions](../interfaces/CreateQueryOptions.md) shape rather than the `initialData`-aware
242overloads above, so whether `data` is defined can't be inferred from the call site β€” useful when wrapping
243`injectQuery` in your own helper function that forwards caller-provided options.
244​
245### Type Parameters
246​
247#### TQueryFnData
248​
249`TQueryFnData` = `unknown`
250​
251#### TError
252​
253`TError` = `Error`
254​
255#### TData
256​
257`TData` = `TQueryFnData`
258​
259#### TQueryKey
260​
261`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
262​
263### Parameters
264​
265#### injectQueryFn
266​
267() => [`CreateQueryOptions`](../interfaces/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
268​
269A function that returns query options. Similar to `computed` from Angular, this
270function runs in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive
271the query.
272​
273#### options?
274​
275[`InjectQueryOptions`](../interfaces/InjectQueryOptions.md)
276​
277Additional configuration
278​
279### Returns
280​
281[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
282​
283The query result.
284​
285### See
286​
287https://tanstack.com/query/latest/docs/framework/angular/guides/queries
288​
289<a id="parameters-summary"></a>
290​
291## Parameters
292​
293### injectQueryFn
294​
295() => [`CreateQueryOptions`](../interfaces/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
296​
297A function that returns query options. Similar to `computed` from Angular, this
298function runs in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive
299the query.
300​
301<a id="injectQueryFn-properties"></a>
302​
303#### `injectQueryFn` properties
304​
305| Property | Type | Default value | Description |
306| ------ | ------ | ------ | ------ |
307| <a id="injectQueryFn-property-enabled"></a> `enabled?` | \| `false` \| `true` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean`) | `true` | Set this to `false` or a function that returns `false` to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use the `refetch` method returned from the `useQuery` instance. Accepts a boolean or function that returns a boolean. |
308| <a id="injectQueryFn-property-gctime"></a> `gcTime?` | `number` | `undefined` | The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used. Setting it to `Infinity` will disable garbage collection. Defaults to `5 * 60 * 1000` (5 minutes), or `Infinity` during SSR. Note: the maximum allowed time is about 24 days, imposed by `setTimeout`'s 32-bit signed integer delay β€” see `timeoutManager.setTimeoutProvider` for a workaround. |
309| <a id="injectQueryFn-property-initialdata"></a> `initialData?` | `TQueryFnData` \| (() => `TQueryFnData` \| `undefined`) | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. |
310| <a id="injectQueryFn-property-initialdataupdatedat"></a> `initialDataUpdatedAt?` | `number` \| (() => `number` \| `undefined`) | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. |
311| <a id="injectQueryFn-property-maxpages"></a> `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. |
312| <a id="injectQueryFn-property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. |
313| <a id="injectQueryFn-property-networkmode"></a> `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. |
314| <a id="injectQueryFn-property-notifyonchangeprops"></a> `notifyOnChangeProps?` | \| ( \| `"error"` \| `"data"` \| `"isError"` \| `"isPending"` \| `"isLoading"` \| `"isLoadingError"` \| `"isRefetchError"` \| `"isSuccess"` \| `"isPlaceholderData"` \| `"status"` \| `"dataUpdatedAt"` \| `"errorUpdatedAt"` \| `"failureCount"` \| `"failureReason"` \| `"errorUpdateCount"` \| `"isFetched"` \| `"isFetchedAfterMount"` \| `"isFetching"` \| `"isInitialLoading"` \| `"isPaused"` \| `"isRefetching"` \| `"isStale"` \| `"isEnabled"` \| `"refetch"` \| `"fetchStatus"` \| `"fetchNextPage"` \| `"fetchPreviousPage"` \| `"hasNextPage"` \| `"hasPreviousPage"` \| `"isFetchNextPageError"` \| `"isFetchingNextPage"` \| `"isFetchPreviousPageError"` \| `"isFetchingPreviousPage"`)[] \| `"all"` \| (() => \| `"all"` \| ( \| `"error"` \| `"data"` \| `"isError"` \| `"isPending"` \| `"isLoading"` \| `"isLoadingError"` \| `"isRefetchError"` \| `"isSuccess"` \| `"isPlaceholderData"` \| `"status"` \| `"dataUpdatedAt"` \| `"errorUpdatedAt"` \| `"failureCount"` \| `"failureReason"` \| `"errorUpdateCount"` \| `"isFetched"` \| `"isFetchedAfterMount"` \| `"isFetching"` \| `"isInitialLoading"` \| `"isPaused"` \| `"isRefetching"` \| `"isStale"` \| `"isEnabled"` \| `"refetch"` \| `"fetchStatus"` \| `"fetchNextPage"` \| `"fetchPreviousPage"` \| `"hasNextPage"` \| `"hasPreviousPage"` \| `"isFetchNextPageError"` \| `"isFetchingNextPage"` \| `"isFetchPreviousPageError"` \| `"isFetchingPreviousPage"`)[] \| `undefined`) | `undefined` | If set, the component will only re-render if any of the listed properties change. When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change. When set to `'all'`, the component will re-render whenever a query is updated. When set to a function, the function will be executed to compute the list of properties. Defaults to `undefined`, in which case property access is tracked automatically, and the component only re-renders when one of the tracked properties changes. |
315| <a id="injectQueryFn-property-persister"></a> `persister?` | (`queryFn`: (`context`: `object`) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\>, `context`: `object`, `query`: [`Query`](../classes/Query.md)) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\> | `undefined` | This option can be used to persist the result of a query to an external storage, bypassing the need to actually call the `queryFn`. Useful for persisting a query's data across e.g. server/client boundaries. |
316| <a id="injectQueryFn-property-placeholderdata"></a> `placeholderData?` | \| `NonFunctionGuard`\<`TQueryFnData`\> \| ((`previousData`: `NonFunctionGuard`\<`TQueryFnData`\> \| `undefined`, `previousQuery`: \| [`Query`](../classes/Query.md)\<`NonFunctionGuard`\<`TQueryFnData`\>, `TError`, `NonFunctionGuard`\<`TQueryFnData`\>, `TQueryKey`\> \| `undefined`) => `NonFunctionGuard`\<`TQueryFnData`\> \| `undefined`) | `undefined` | If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided. |
317| <a id="injectQueryFn-property-queryfn"></a> `queryFn?` | \| *typeof* [`skipToken`](../variables/skipToken.md) \| ((`context`: `object`) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\>) | `undefined` | The function that the query will use to request data. Required, unless a default query function has been set via `queryClient.setQueryDefaults` or `queryClient.setDefaultOptions`. Receives a [QueryFunctionContext](../type-aliases/QueryFunctionContext.md). Must return a promise that will either resolve data or throw an error. The data cannot be `undefined`. |
318| <a id="injectQueryFn-property-queryhash"></a> `queryHash?` | `string` | `undefined` | The hashed form of `queryKey`, computed with `queryKeyHashFn` (or the default hashing function otherwise). Used as the actual cache key internally. |
319| <a id="injectQueryFn-property-querykey"></a> `queryKey` | `TQueryKey` & `object` | `undefined` | The query key to use for this query. The query key will be hashed into a stable hash. See [Query Keys](https://tanstack.com/query/latest/docs/framework/react/guides/query-keys) for more information. The query will automatically update when this key changes (as long as `enabled` is not set to `false`). |
320| <a id="injectQueryFn-property-querykeyhashfn"></a> `queryKeyHashFn?` | (`queryKey`: `TQueryKey`) => `string` | `undefined` | If specified, this function is used to hash the `queryKey` to a string. |
321| <a id="injectQueryFn-property-refetchinterval"></a> `refetchInterval?` | \| `number` \| `false` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `number` \| `false` \| `undefined`) | `false` | If set to a number, the query will continuously refetch at this frequency in milliseconds. If set to a function, the function will be executed with the latest data and query to compute a frequency |
322| <a id="injectQueryFn-property-refetchintervalinbackground"></a> `refetchIntervalInBackground?` | `boolean` | `false` | If set to `true`, the query will continue to refetch while their tab/window is in the background. |
323| <a id="injectQueryFn-property-refetchonmount"></a> `refetchOnMount?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean` \| `"always"`) | `true` | If set to `true`, the query will refetch on mount if the data is stale. If set to `false`, will disable additional instances of a query to trigger background refetch. If set to `'always'`, the query will always refetch on mount (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value |
324| <a id="injectQueryFn-property-refetchonreconnect"></a> `refetchOnReconnect?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean` \| `"always"`) | `undefined` | If set to `true`, the query will refetch on reconnect if the data is stale. If set to `false`, the query will not refetch on reconnect. If set to `'always'`, the query will always refetch on reconnect (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to `true` unless `networkMode` is `'always'`. |
325| <a id="injectQueryFn-property-refetchonwindowfocus"></a> `refetchOnWindowFocus?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean` \| `"always"`) | `true` | If set to `true`, the query will refetch on window focus if the data is stale. If set to `false`, the query will not refetch on window focus. If set to `'always'`, the query will always refetch on window focus (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value. |
326| <a id="injectQueryFn-property-retry"></a> `retry?` | \| `number` \| `false` \| `true` \| ((`failureCount`: `number`, `error`: `TError`) => `boolean`) | `undefined` | If `false`, failed queries will not retry by default. If `true`, failed queries will retry infinitely. If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false. Defaults to `3` on the client and `0` on the server. |
327| <a id="injectQueryFn-property-retrydelay"></a> `retryDelay?` | `number` \| ((`failureCount`: `number`, `error`: `TError`) => `number`) | `undefined` | This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds. A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff. A function like `attempt => attempt * 1000` applies linear backoff. Defaults to a function that applies exponential backoff, capped at 30 seconds. |
328| <a id="injectQueryFn-property-retryonmount"></a> `retryOnMount?` | \| `false` \| `true` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean`) | `true` | If set to `false`, the query will not be retried on mount if it contains an error. If set to a function, the function will be executed with the query to compute the value. |
329| <a id="injectQueryFn-property-select"></a> `select?` | (`data`: `TQueryFnData`) => `TData` | `undefined` | This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache. The `select` function will only run if `data` changed, or if the reference to the `select` function itself changes. To optimize, memoize the function so its reference stays stable across calls. |
330| <a id="injectQueryFn-property-staletime"></a> `staleTime?` | \| `number` \| `"static"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `number` \| `"static"`) | `0` | The time in milliseconds after data is considered stale. If set to `Infinity`, the data will never be considered stale. If set to `'static'`, the data will never be considered stale. If set to a function, the function will be executed with the query to compute a `staleTime`. |
331| <a id="injectQueryFn-property-structuralsharing"></a> `structuralSharing?` | `boolean` \| ((`oldData`: `unknown`, `newData`: `unknown`) => `unknown`) | `true` | Set this to `false` to disable structural sharing between query results. Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic. |
332| <a id="injectQueryFn-property-throwonerror"></a> `throwOnError?` | \| `false` \| `true` \| ((`error`: `TError`, `query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, `TQueryFnData`, `TQueryKey`\>) => `boolean`) | `false` | Whether errors should be thrown instead of setting the `error` property. If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary. If set to `false` and `suspense` is `false`, errors are returned as state. If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`). |
333​
334### options?
335​
336[`InjectQueryOptions`](../interfaces/InjectQueryOptions.md)
337​
338Additional configuration
339​
340<a id="options-properties"></a>
341​
342#### `options` properties
343​
344| Property | Type | Description |
345| ------ | ------ | ------ |
346| <a id="options-property-injector"></a> `injector?` | `Injector` | The `Injector` in which to create the query. If this is not provided, the current injection context will be used instead (via `inject`). |
347​
348<a id="returns-summary"></a>
349​
350## Returns
351​
352[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
353​
354The query result.