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