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

injectQuery.md

290 lines9.7 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[]>(optionsFn: () => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedCreateQueryResult<TData, TError>;
12function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(optionsFn: () => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
13function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(optionsFn: () => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
14```
15​
16- [`() => DefinedInitialDataOptions` β†’ `DefinedCreateQueryResult`](#call-signature-1): This overload is selected when `initialData` is set on the options returned by `optionsFn`, 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](../type-aliases/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[]>(optionsFn: () => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedCreateQueryResult<TData, TError>;
28```
29​
30Defined in: [packages/angular-query/src/inject-query.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query/src/inject-query.ts#L59)
31​
32This overload is selected when `initialData` is set on the options returned by `optionsFn`, so the
33resulting `data` signal is never `undefined` (unless a `select` changes `TData` to include `undefined`).
34​
35### Type Parameters
36​
37#### TQueryFnData
38​
39`TQueryFnData` = `unknown`
40​
41#### TError
42​
43`TError` = `Error`
44​
45#### TData
46​
47`TData` = `TQueryFnData`
48​
49#### TQueryKey
50​
51`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
52​
53### Parameters
54​
55#### optionsFn
56​
57() => [`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
58​
59A function returning the [DefinedInitialDataOptions](../type-aliases/DefinedInitialDataOptions.md) to use β€” everything you
60can pass to `injectQuery`, with `initialData` set. Similar to `computed` from Angular, this function runs
61in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive the query.
62​
63### Returns
64​
65[`DefinedCreateQueryResult`](../type-aliases/DefinedCreateQueryResult.md)\<`TData`, `TError`\>
66​
67The query result, typed so that `data` is never `undefined` (unless a `select` changes `TData` to
68include `undefined`).
69​
70### See
71​
72 - https://tanstack.com/query/latest/docs/framework/angular/guides/queries
73 - [queryOptions](queryOptions.md) to share these options between `injectQuery` and imperative APIs like
74`queryClient.query`.
75​
76### Example
77​
78```angular-ts
79@Component({
80 selector: 'posts',
81 template: `
82 <!-- `postsQuery.data()` is `Post[]`, never `undefined`, thanks to `initialData` β€” even if a
83 refetch fails, so the list stays visible alongside the error. -->
84 @if (postsQuery.isError()) {
85 <span>Error: {{ postsQuery.error()?.message }}</span>
86 }
87 <ul>
88 @for (post of postsQuery.data(); track post.id) {
89 <li>{{ post.title }}</li>
90 }
91 </ul>
92 `,
93})
94export class Posts {
95 readonly postsQuery = injectQuery(() => ({
96 queryKey: ['posts'],
97 queryFn: fetchPosts,
98 initialData: [],
99 }))
101```
102​
103<a id="call-signature-2"></a>
104​
105## Call Signature
106​
107```ts
108function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(optionsFn: () => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
109```
110​
111Defined in: [packages/angular-query/src/inject-query.ts:142](https://github.com/TanStack/query/blob/main/packages/angular-query/src/inject-query.ts#L142)
112​
113Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
114​
115### Type Parameters
116​
117#### TQueryFnData
118​
119`TQueryFnData` = `unknown`
120​
121#### TError
122​
123`TError` = `Error`
124​
125#### TData
126​
127`TData` = `TQueryFnData`
128​
129#### TQueryKey
130​
131`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
132​
133### Parameters
134​
135#### optionsFn
136​
137() => [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
138​
139A function returning the [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything
140you can pass to `injectQuery`. Similar to `computed` from Angular, this function runs in the reactive
141context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive the query.
142​
143### Returns
144​
145[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
146​
147The query result. `status()` is `'pending'` if there is no cached data to display, `'error'` if
148the last fetch attempt failed, or `'success'` if the query has data to display. `isPending`/`isSuccess`/
149`isError` are type-guard methods for convenience.
150​
151### See
152​
153 - https://tanstack.com/query/latest/docs/framework/angular/guides/queries
154 - [queryOptions](queryOptions.md) to share these options between `injectQuery` and imperative APIs like
155`queryClient.query`.
156​
157### Examples
158​
159```angular-ts
160@Component({
161 selector: 'posts',
162 template: `
163 @if (postsQuery.isPending()) {
164 Loading...
165 } @else if (postsQuery.isError()) {
166 <span>Error: {{ postsQuery.error()?.message }}</span>
167 } @else {
168 <ul>
169 @for (post of postsQuery.data(); track post.id) {
170 <li>{{ post.title }}</li>
171 }
172 </ul>
173 }
174 `,
175})
176export class Posts {
177 readonly postsQuery = injectQuery(() => ({
178 queryKey: ['posts'],
179 queryFn: fetchPosts,
180 }))
182```
183​
184Similar to `computed` from Angular, the function passed to `injectQuery` runs in the reactive context. In
185the example below, the query is automatically enabled and executed when the filter signal changes to a
186truthy value. When the filter signal changes back to a falsy value, the query is disabled.
187```angular-ts
188@Component({
189 selector: 'posts',
190 template: `
191 <input [ngModel]="filter()" (ngModelChange)="filter.set($event)" />
192 @if (postsQuery.isPending()) {
193 Loading...
194 } @else if (postsQuery.isError()) {
195 <span>Error: {{ postsQuery.error()?.message }}</span>
196 } @else {
197 <ul>
198 @for (post of postsQuery.data(); track post.id) {
199 <li>{{ post.title }}</li>
200 }
201 </ul>
202 }
203 `,
204})
205export class Posts {
206 readonly filter = signal('')
207​
208 readonly postsQuery = injectQuery(() => ({
209 queryKey: ['posts', this.filter()],
210 queryFn: () => fetchPosts(this.filter()),
211 enabled: !!this.filter(),
212 }))
214```
215​
216<a id="call-signature-3"></a>
217​
218## Call Signature
219​
220```ts
221function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(optionsFn: () => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
222```
223​
224Defined in: [packages/angular-query/src/inject-query.ts:165](https://github.com/TanStack/query/blob/main/packages/angular-query/src/inject-query.ts#L165)
225​
226This overload accepts the general [CreateQueryOptions](../type-aliases/CreateQueryOptions.md) shape rather than the `initialData`-aware
227overloads above, so whether `data` is defined can't be inferred from the call site β€” useful when wrapping
228`injectQuery` in your own helper function that forwards caller-provided options.
229​
230### Type Parameters
231​
232#### TQueryFnData
233​
234`TQueryFnData` = `unknown`
235​
236#### TError
237​
238`TError` = `Error`
239​
240#### TData
241​
242`TData` = `TQueryFnData`
243​
244#### TQueryKey
245​
246`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
247​
248### Parameters
249​
250#### optionsFn
251​
252() => [`CreateQueryOptions`](../type-aliases/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
253​
254A function that returns query options. Similar to `computed` from Angular, this
255function runs in the reactive context, so signals read inside it drive the query.
256​
257### Returns
258​
259[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
260​
261The query result.
262​
263### See
264​
265https://tanstack.com/query/latest/docs/framework/angular/guides/queries
266​
267<a id="parameters-summary"></a>
268​
269## Parameters
270​
271### optionsFn
272​
273() => [`CreateQueryOptions`](../type-aliases/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
274​
275A function that returns query options. Similar to `computed` from Angular, this
276function runs in the reactive context, so signals read inside it drive the query.
277​
278<a id="optionsFn-properties"></a>
279​
280#### `optionsFn` properties
281​
282Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.
283​
284<a id="returns-summary"></a>
285​
286## Returns
287​
288[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
289​
290The query result.