Open History to see the last commit
1---
2id: QueriesObserver
3title: QueriesObserver
4redirect_from:
5 - reference/QueriesObserver
6 - framework/react/reference/QueriesObserver
7---
8β
9Defined in: [packages/query-core/src/queriesObserver.ts:64](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L64)
10β
11A `QueriesObserver` watches an array of queries at once, exposing them as
12a single array of `QueryObserverResult`s (or, when a `combine` option is
13given, as a combined value derived from that array). It manages one
14internal `QueryObserver` per query, and is the primitive that framework
15adapters (e.g. `useQueries`) build their hooks on top of.
16β
17## Example
18β
19```ts
20const observer = new QueriesObserver(queryClient, [
21 { queryKey: ['post', 1], queryFn: fetchPost },
22 { queryKey: ['post', 2], queryFn: fetchPost },
23])
24β
25const unsubscribe = observer.subscribe((result) => {
26 console.log(result)
27})
28```
29β
30## Extends
31β
32- `Subscribable`\<`QueriesObserverListener`\>
33β
34## Type Parameters
35β
36### TCombinedResult
37β
38`TCombinedResult` = [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]
39β
40## Constructors
41β
42### Constructor
43β
44```ts
45new QueriesObserver<TCombinedResult>(
46 client: QueryClient,
47 queries: QueryObserverOptions<any, any, any, any, any, never>[],
48options?: QueriesObserverOptions<TCombinedResult>): QueriesObserver<TCombinedResult>;
49```
50β
51Defined in: [packages/query-core/src/queriesObserver.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L78)
52β
53#### Parameters
54β
55##### client
56β
57[`QueryClient`](QueryClient.md)
58β
59##### queries
60β
61[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`any`, `any`, `any`, `any`, `any`, `never`\>[]
62β
63##### options?
64β
65[`QueriesObserverOptions`](../interfaces/QueriesObserverOptions.md)\<`TCombinedResult`\>
66β
67#### Returns
68β
69`QueriesObserver`\<`TCombinedResult`\>
70β
71#### Overrides
72β
73```ts
74Subscribable<QueriesObserverListener>.constructor
75```
76β
77## Methods
78β
79### destroy()
80β
81```ts
82destroy(): void;
83```
84β
85Defined in: [packages/query-core/src/queriesObserver.ts:114](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L114)
86β
87Stops observing all queries: clears all listeners and destroys every
88underlying `QueryObserver` this observer manages.
89β
90#### Returns
91β
92`void`
93β
94***
95β
96### getCurrentResult()
97β
98```ts
99getCurrentResult(): QueryObserverResult[];
100```
101β
102Defined in: [packages/query-core/src/queriesObserver.ts:219](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L219)
103β
104Returns the most recently computed array of `QueryObserverResult`s, one
105per observed query, in the same order as the queries passed to the
106constructor or `setQueries`.
107β
108#### Returns
109β
110[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]
111β
112The current results.
113β
114#### Example
115β
116```ts
117const results = observer.getCurrentResult()
118const data = results.map((result) => result.data)
119```
120β
121***
122β
123### getObservers()
124β
125```ts
126getObservers(): QueryObserver<unknown, Error, unknown, unknown, readonly unknown[]>[];
127```
128β
129Defined in: [packages/query-core/src/queriesObserver.ts:238](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L238)
130β
131Returns the underlying `QueryObserver` instances this observer manages,
132in the same order as the queries passed to the constructor or
133`setQueries`.
134β
135#### Returns
136β
137[`QueryObserver`](QueryObserver.md)\<`unknown`, `Error`, `unknown`, `unknown`, readonly `unknown`[]\>[]
138β
139The managed query observers.
140β
141***
142β
143### getOptimisticResult()
144β
145```ts
146getOptimisticResult(queries: QueryObserverOptions<unknown, Error, unknown, unknown, readonly unknown[], never>[], combine: CombineFn<TCombinedResult> | undefined): [QueryObserverResult[], (r?: QueryObserverResult[]) => TCombinedResult, () => QueryObserverResult[]];
147```
148β
149Defined in: [packages/query-core/src/queriesObserver.ts:253](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L253)
150β
151The `QueriesObserver` counterpart of [QueryObserver#getOptimisticResult](QueryObserver.md#getoptimisticresult) β computes
152the result for the given (already-defaulted) queries right now, synchronously. Called by
153framework adapters (e.g. `useQueries`) ahead of subscribing, returning a tuple of the raw
154per-query results, a function to compute the combined result from them, and a function to
155wrap the results for property-access tracking.
156β
157#### Parameters
158β
159##### queries
160β
161[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`unknown`, `Error`, `unknown`, `unknown`, readonly `unknown`[], `never`\>[]
162β
163The defaulted options of the queries to compute the result for.
164β
165##### combine
166β
167`CombineFn`\<`TCombinedResult`\> \| `undefined`
168β
169The `combine` function used by the returned `combineResult`, if any.
170β
171#### Returns
172β
173\[[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[], (`r?`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]) => `TCombinedResult`, () => [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]\]
174β
175A tuple of the per-query results, a function that computes the combined result, and a
176function that returns the results wrapped for property-access tracking.
177β
178***
179β
180### getQueries()
181β
182```ts
183getQueries(): Query<unknown, Error, unknown, readonly unknown[]>[];
184```
185β
186Defined in: [packages/query-core/src/queriesObserver.ts:228](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L228)
187β
188Returns the underlying `Query` instances currently being observed, in
189the same order as the queries passed to the constructor or `setQueries`.
190β
191#### Returns
192β
193[`Query`](Query.md)\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>[]
194β
195The observed queries.
196β
197***
198β
199### hasListeners()
200β
201```ts
202hasListeners(): boolean;
203```
204β
205Defined in: [packages/query-core/src/subscribable.ts:43](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L43)
206β
207Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.
208β
209#### Returns
210β
211`boolean`
212β
213`true` if at least one listener is registered.
214β
215#### Inherited from
216β
217```ts
218Subscribable.hasListeners
219```
220β
221***
222β
223### setQueries()
224β
225```ts
226setQueries(queries: QueryObserverOptions<unknown, Error, unknown, unknown, readonly unknown[], never>[], options?: QueriesObserverOptions<TCombinedResult>): void;
227```
228β
229Defined in: [packages/query-core/src/queriesObserver.ts:136](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L136)
230β
231Replaces the set of queries being observed. Existing `QueryObserver`s
232are reused for queries that match an already-observed query hash;
233observers for queries that are no longer present are destroyed, and new
234observers are created and subscribed to for newly added queries.
235β
236#### Parameters
237β
238##### queries
239β
240[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`unknown`, `Error`, `unknown`, `unknown`, readonly `unknown`[], `never`\>[]
241β
242The options of the queries to observe.
243β
244##### options?
245β
246[`QueriesObserverOptions`](../interfaces/QueriesObserverOptions.md)\<`TCombinedResult`\>
247β
248Replaces the observer's options, e.g. its `combine` function.
249β
250#### Returns
251β
252`void`
253β
254#### Example
255β
256```ts
257observer.setQueries([
258 { queryKey: ['post', 1], queryFn: fetchPost },
259 { queryKey: ['post', 3], queryFn: fetchPost },
260])
261```
262β
263***
264β
265### subscribe()
266β
267```ts
268subscribe(listener: QueriesObserverListener): () => void;
269```
270β
271Defined in: [packages/query-core/src/subscribable.ts:28](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L28)
272β
273Registers a listener to be called on every update this object notifies about. Returns a function
274that removes the listener again β call it to stop listening. The base class never drops a listener
275on its own, though some subclasses clear all of theirs in `destroy()`.
276β
277#### Parameters
278β
279##### listener
280β
281`QueriesObserverListener`
282β
283Called on each update, with whatever the subclass passes to its subscribers.
284β
285#### Returns
286β
287A function that removes the listener.
288β
289() => `void`
290β
291#### Example
292β
293```ts
294const unsubscribe = subscribable.subscribe(() => {
295 // react to the update
296})
297β
298unsubscribe()
299```
300β
301#### Inherited from
302β
303```ts
304Subscribable.subscribe
305```