Open History to see the last commit
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 known to be defined 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 known to be defined 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` known to be defined. 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`). At runtime, `data` is still `undefined` if `select` throws on its first call.
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 }))
100}
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:144](https://github.com/TanStack/query/blob/main/packages/angular-query/src/inject-query.ts#L144)
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 `'error'` if the query has an error from a fetch that failed
148after its retries or if `select` threw, `'success'` if the query has cached data (even if `select`
149returns `undefined`) or data from `placeholderData`, and `'pending'` otherwise.
150`isPending`/`isSuccess`/`isError` are type-guard methods for convenience.
151β
152### See
153β
154 - https://tanstack.com/query/latest/docs/framework/angular/guides/queries
155 - [queryOptions](queryOptions.md) to share these options between `injectQuery` and imperative APIs like
156`queryClient.query`.
157β
158### Examples
159β
160```angular-ts
161@Component({
162 selector: 'posts',
163 template: `
164 @if (postsQuery.isPending()) {
165 Loading...
166 } @else if (postsQuery.isError()) {
167 <span>Error: {{ postsQuery.error()?.message }}</span>
168 } @else {
169 <ul>
170 @for (post of postsQuery.data(); track post.id) {
171 <li>{{ post.title }}</li>
172 }
173 </ul>
174 }
175 `,
176})
177export class Posts {
178 readonly postsQuery = injectQuery(() => ({
179 queryKey: ['posts'],
180 queryFn: fetchPosts,
181 }))
182}
183```
184β
185Similar to `computed` from Angular, the function passed to `injectQuery` runs in the reactive context. In
186the example below, the query is automatically enabled and executed when the filter signal changes to a
187truthy value. When the filter signal changes back to a falsy value, the query is disabled.
188```angular-ts
189@Component({
190 selector: 'posts',
191 template: `
192 <input [ngModel]="filter()" (ngModelChange)="filter.set($event)" />
193 @if (postsQuery.isPending()) {
194 Loading...
195 } @else if (postsQuery.isError()) {
196 <span>Error: {{ postsQuery.error()?.message }}</span>
197 } @else {
198 <ul>
199 @for (post of postsQuery.data(); track post.id) {
200 <li>{{ post.title }}</li>
201 }
202 </ul>
203 }
204 `,
205})
206export class Posts {
207 readonly filter = signal('')
208β
209 readonly postsQuery = injectQuery(() => ({
210 queryKey: ['posts', this.filter()],
211 queryFn: () => fetchPosts(this.filter()),
212 // Signals can be combined with expressions
213 enabled: !!this.filter(),
214 }))
215}
216```
217β
218<a id="call-signature-3"></a>
219β
220## Call Signature
221β
222```ts
223function injectQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(optionsFn: () => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
224```
225β
226Defined in: [packages/angular-query/src/inject-query.ts:168](https://github.com/TanStack/query/blob/main/packages/angular-query/src/inject-query.ts#L168)
227β
228This overload accepts the general [CreateQueryOptions](../type-aliases/CreateQueryOptions.md) shape rather than the `initialData`-aware
229overloads above, so whether `data` is defined can't be inferred from the call site β useful when wrapping
230`injectQuery` in your own helper function that forwards caller-provided options.
231β
232### Type Parameters
233β
234#### TQueryFnData
235β
236`TQueryFnData` = `unknown`
237β
238#### TError
239β
240`TError` = `Error`
241β
242#### TData
243β
244`TData` = `TQueryFnData`
245β
246#### TQueryKey
247β
248`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
249β
250### Parameters
251β
252#### optionsFn
253β
254() => [`CreateQueryOptions`](../type-aliases/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
255β
256A function that returns query options. Similar to `computed` from Angular, this
257function runs in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive
258the query.
259β
260### Returns
261β
262[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
263β
264The query result.
265β
266### See
267β
268https://tanstack.com/query/latest/docs/framework/angular/guides/queries
269β
270<a id="parameters-summary"></a>
271β
272## Parameters
273β
274### optionsFn
275β
276() => [`CreateQueryOptions`](../type-aliases/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
277β
278A function that returns query options. Similar to `computed` from Angular, this
279function runs in the reactive context, so signals read inside it (in `queryKey`, `enabled`, etc.) drive
280the query.
281β
282<a id="optionsFn-properties"></a>
283β
284#### `optionsFn` properties
285β
286Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.
287β
288<a id="returns-summary"></a>
289β
290## Returns
291β
292[`CreateQueryResult`](../type-aliases/CreateQueryResult.md)\<`TData`, `TError`\>
293β
294The query result.