Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

QueriesObserver.md

305 lines8.0 KB

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`
58​
59##### queries
60​
61`QueryObserverOptions`\<`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: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`\<`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\[`rawResult`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[], `combineResult`: (`r?`: [`QueryObserverResult`](../type-aliases/QueryObserverResult.md)[]) => `TCombinedResult`, `trackResult`: () => [`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`\<`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```