Open History to see the last commit
1---
2id: QueriesObserver
3title: QueriesObserver
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8Defined in: [packages/query-core/src/queriesObserver.ts:64](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L64)
9β
10A `QueriesObserver` watches an array of queries at once, exposing them as
11a single array of `QueryObserverResult`s (or, when a `combine` option is
12given, as a combined value derived from that array). It manages one
13internal `QueryObserver` per query, and is the primitive that framework
14adapters (e.g. `useQueries`) build their hooks on top of.
15β
16## Example
17β
18```ts
19const observer = new QueriesObserver(queryClient, [
20 { queryKey: ['post', 1], queryFn: fetchPost },
21 { queryKey: ['post', 2], queryFn: fetchPost },
22])
23β
24const unsubscribe = observer.subscribe((result) => {
25 console.log(result)
26})
27```
28β
29## Extends
30β
31- `Subscribable`\<`QueriesObserverListener`\>
32β
33## Type Parameters
34β
35### TCombinedResult
36β
37`TCombinedResult` = [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]
38β
39## Constructors
40β
41### Constructor
42β
43```ts
44new QueriesObserver<TCombinedResult = QueryObserverResult[]>(
45 client: QueryClient,
46 queries: QueryObserverOptions<any, any, any, any, any, never>[],
47 options?: QueriesObserverOptions<TCombinedResult>
48): 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): [rawResult: QueryObserverResult[], combineResult: (r?: QueryObserverResult[]) => TCombinedResult, trackResult: () => QueryObserverResult[]];
147```
148β
149Defined in: [packages/query-core/src/queriesObserver.ts:255](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L255)
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. When the queries match the observed ones, the
156results also become the current result, so a later `setQueries` call with the same queries
157does not notify the listeners about them.
158β
159#### Parameters
160β
161##### queries
162β
163[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`unknown`, `Error`, `unknown`, `unknown`, readonly `unknown`[], `never`\>[]
164β
165The defaulted options of the queries to compute the result for.
166β
167##### combine
168β
169`CombineFn`\<`TCombinedResult`\> \| `undefined`
170β
171The `combine` function used by the returned `combineResult`, if any.
172β
173#### Returns
174β
175\[`rawResult`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[], `combineResult`: (`r?`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]) => `TCombinedResult`, `trackResult`: () => [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]\]
176β
177A tuple of the per-query results, a function that computes the combined result, and a
178function that returns the results wrapped for property-access tracking.
179β
180***
181β
182### getQueries()
183β
184```ts
185getQueries(): Query<unknown, Error, unknown, readonly unknown[]>[];
186```
187β
188Defined in: [packages/query-core/src/queriesObserver.ts:228](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L228)
189β
190Returns the underlying `Query` instances currently being observed, in
191the same order as the queries passed to the constructor or `setQueries`.
192β
193#### Returns
194β
195[`Query`](Query.md)\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>[]
196β
197The observed queries.
198β
199***
200β
201### hasListeners()
202β
203```ts
204hasListeners(): boolean;
205```
206β
207Defined in: [packages/query-core/src/subscribable.ts:46](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L46)
208β
209Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.
210β
211#### Returns
212β
213`boolean`
214β
215`true` if at least one listener is registered.
216β
217#### Inherited from
218β
219```ts
220Subscribable.hasListeners
221```
222β
223***
224β
225### setQueries()
226β
227```ts
228setQueries(queries: QueryObserverOptions<unknown, Error, unknown, unknown, readonly unknown[], never>[], options?: QueriesObserverOptions<TCombinedResult>): void;
229```
230β
231Defined in: [packages/query-core/src/queriesObserver.ts:136](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L136)
232β
233Replaces the set of queries being observed. Existing `QueryObserver`s
234are reused for queries that match an already-observed query hash;
235observers for queries that are no longer present are destroyed, and new
236observers are created and subscribed to for newly added queries.
237β
238#### Parameters
239β
240##### queries
241β
242[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`unknown`, `Error`, `unknown`, `unknown`, readonly `unknown`[], `never`\>[]
243β
244The options of the queries to observe.
245β
246##### options?
247β
248[`QueriesObserverOptions`](../interfaces/QueriesObserverOptions.md)\<`TCombinedResult`\>
249β
250Replaces the observer's options, e.g. its `combine` function.
251β
252#### Returns
253β
254`void`
255β
256#### Example
257β
258```ts
259observer.setQueries([
260 { queryKey: ['post', 1], queryFn: fetchPost },
261 { queryKey: ['post', 3], queryFn: fetchPost },
262])
263```
264β
265***
266β
267### subscribe()
268β
269```ts
270subscribe(listener: QueriesObserverListener): () => void;
271```
272β
273Defined in: [packages/query-core/src/subscribable.ts:31](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L31)
274β
275Registers a listener to be called on every update this object notifies about. Returns a function
276that removes the listener again β call it to stop listening. The base class never drops a listener
277on its own, though some subclasses clear all of theirs in `destroy()`.
278β
279#### Parameters
280β
281##### listener
282β
283`QueriesObserverListener`
284β
285Called on each update, with whatever the subclass passes to its subscribers.
286β
287#### Returns
288β
289A function that removes the listener.
290β
291() => `void`
292β
293#### Example
294β
295```ts
296const unsubscribe = subscribable.subscribe(() => {
297 // react to the update
298})
299β
300unsubscribe()
301```
302β
303#### Inherited from
304β
305```ts
306Subscribable.subscribe
307```