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

QueriesObserver.md

310 lines8.4 KB

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```