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