Open History to see the last commit
1---
2id: useQueries
3title: useQueries
4redirect_from:
5 - framework/solid/reference/useQueries
6---
7β
8<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
9β
10```ts
11function useQueries<T extends any[], TCombinedResult extends
12 | []
13 | [
14 | QueryObserverRefetchErrorResult<unknown, Error>
15 | QueryObserverSuccessResult<unknown, Error>
16 | QueryObserverLoadingErrorResult<unknown, Error>
17 | QueryObserverLoadingResult<unknown, Error>
18 | QueryObserverPendingResult<unknown, Error>
19 | QueryObserverPlaceholderResult<unknown, Error>
20 | QueryObserverRefetchErrorResult<unknown, unknown>
21 | QueryObserverSuccessResult<unknown, unknown>
22 | QueryObserverLoadingErrorResult<unknown, unknown>
23 | QueryObserverLoadingResult<unknown, unknown>
24 | QueryObserverPendingResult<unknown, unknown>
25 | QueryObserverPlaceholderResult<unknown, unknown>]
26 | (
27 | QueryObserverRefetchErrorResult<unknown, Error>
28 | QueryObserverSuccessResult<unknown, Error>
29 | QueryObserverLoadingErrorResult<unknown, Error>
30 | QueryObserverLoadingResult<unknown, Error>
31 | QueryObserverPendingResult<unknown, Error>
32 | QueryObserverPlaceholderResult<unknown, Error>
33 | QueryObserverRefetchErrorResult<unknown, unknown>
34 | QueryObserverSuccessResult<unknown, unknown>
35 | QueryObserverLoadingErrorResult<unknown, unknown>
36 | QueryObserverLoadingResult<unknown, unknown>
37 | QueryObserverPendingResult<unknown, unknown>
38 | QueryObserverPlaceholderResult<unknown, unknown>)[] = T extends [] ? [] : T extends [Head] ? [GetResults<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetResults<Head>, GetResults<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetResults<Head>, GetResults<Head>, GetResults<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : ... extends ... ? ... : ... : [...{ [K in (...)]: (...) }[]] : [...{ [K in string | number | symbol]: GetResults<Tail[K]> }[]] : { [K in string | number | symbol]: GetResults<T[K]> }>(queriesOptions: Accessor<{
39 combine?: (result: T extends [] ? [] : T extends [Head] ? [GetResults<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetResults<...>, GetResults<...>] : [...(...)[]] extends [..., ...(...)[]] ? ... extends ... ? ... : ... : [...(...)[]] : { [K in string | number | symbol]: GetResults<T[K]> }) => TCombinedResult;
40 queries: | readonly [T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<...>, GetOptions<...>] : [...(...)[]] extends [..., ...(...)[]] ? ... extends ... ? ... : ... : ... extends ... ? ... : ... : readonly unknown[] extends T ? T : T extends UseQueryOptionsForUseQueries<..., ..., ..., ...>[] ? UseQueryOptionsForUseQueries<..., ..., ..., ...>[] : UseQueryOptionsForUseQueries<..., ..., ..., ...>[]]
41 | readonly [{ [K in string | number | symbol]: GetOptions<T[K]> }];
42}>, queryClient?: Accessor<QueryClient>): TCombinedResult;
43```
44β
45Defined in: [packages/solid-query/src/useQueries.ts:272](https://github.com/TanStack/query/blob/main/packages/solid-query/src/useQueries.ts#L272)
46β
47The `useQueries` primitive can be used to fetch a variable number of queries.
48β
49The `queries` key accepts an array with query option objects mostly identical to `useQuery` β see
50`placeholderData` below for the one difference. A custom `QueryClient` is supplied once, as `useQueries`'
51own top-level second argument, rather than per query.
52β
53Having the same query key more than once in the array of query objects may cause some data to be shared
54between queries. To avoid this, consider de-duplicating the queries and map the results back to the desired
55structure.
56β
57The `combine` option can be used to combine the results of the queries into a single value. The result will
58be structurally shared to be as referentially stable as possible.
59β
60`placeholderData` is supported here too, but unlike `useQuery`, it doesn't receive information from
61previously rendered queries, because the number of queries can differ between renders.
62β
63## Type Parameters
64β
65### T
66β
67`T` *extends* `any`[]
68β
69### TCombinedResult
70β
71`TCombinedResult` *extends*
72 \| \[\]
73 \| \[
74 \| [`QueryObserverRefetchErrorResult`](../interfaces/QueryObserverRefetchErrorResult.md)\<`unknown`, `Error`\>
75 \| [`QueryObserverSuccessResult`](../interfaces/QueryObserverSuccessResult.md)\<`unknown`, `Error`\>
76 \| [`QueryObserverLoadingErrorResult`](../interfaces/QueryObserverLoadingErrorResult.md)\<`unknown`, `Error`\>
77 \| [`QueryObserverLoadingResult`](../interfaces/QueryObserverLoadingResult.md)\<`unknown`, `Error`\>
78 \| [`QueryObserverPendingResult`](../interfaces/QueryObserverPendingResult.md)\<`unknown`, `Error`\>
79 \| [`QueryObserverPlaceholderResult`](../interfaces/QueryObserverPlaceholderResult.md)\<`unknown`, `Error`\>
80 \| [`QueryObserverRefetchErrorResult`](../interfaces/QueryObserverRefetchErrorResult.md)\<`unknown`, `unknown`\>
81 \| [`QueryObserverSuccessResult`](../interfaces/QueryObserverSuccessResult.md)\<`unknown`, `unknown`\>
82 \| [`QueryObserverLoadingErrorResult`](../interfaces/QueryObserverLoadingErrorResult.md)\<`unknown`, `unknown`\>
83 \| [`QueryObserverLoadingResult`](../interfaces/QueryObserverLoadingResult.md)\<`unknown`, `unknown`\>
84 \| [`QueryObserverPendingResult`](../interfaces/QueryObserverPendingResult.md)\<`unknown`, `unknown`\>
85 \| [`QueryObserverPlaceholderResult`](../interfaces/QueryObserverPlaceholderResult.md)\<`unknown`, `unknown`\>\]
86 \| (
87 \| [`QueryObserverRefetchErrorResult`](../interfaces/QueryObserverRefetchErrorResult.md)\<`unknown`, `Error`\>
88 \| [`QueryObserverSuccessResult`](../interfaces/QueryObserverSuccessResult.md)\<`unknown`, `Error`\>
89 \| [`QueryObserverLoadingErrorResult`](../interfaces/QueryObserverLoadingErrorResult.md)\<`unknown`, `Error`\>
90 \| [`QueryObserverLoadingResult`](../interfaces/QueryObserverLoadingResult.md)\<`unknown`, `Error`\>
91 \| [`QueryObserverPendingResult`](../interfaces/QueryObserverPendingResult.md)\<`unknown`, `Error`\>
92 \| [`QueryObserverPlaceholderResult`](../interfaces/QueryObserverPlaceholderResult.md)\<`unknown`, `Error`\>
93 \| [`QueryObserverRefetchErrorResult`](../interfaces/QueryObserverRefetchErrorResult.md)\<`unknown`, `unknown`\>
94 \| [`QueryObserverSuccessResult`](../interfaces/QueryObserverSuccessResult.md)\<`unknown`, `unknown`\>
95 \| [`QueryObserverLoadingErrorResult`](../interfaces/QueryObserverLoadingErrorResult.md)\<`unknown`, `unknown`\>
96 \| [`QueryObserverLoadingResult`](../interfaces/QueryObserverLoadingResult.md)\<`unknown`, `unknown`\>
97 \| [`QueryObserverPendingResult`](../interfaces/QueryObserverPendingResult.md)\<`unknown`, `unknown`\>
98 \| [`QueryObserverPlaceholderResult`](../interfaces/QueryObserverPlaceholderResult.md)\<`unknown`, `unknown`\>)[] = `T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetResults`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] *extends* \[\] ? \[\] : \[`...Tail[]`\] *extends* \[`Head`\] ? \[`GetResults`\<`Head`\>, `GetResults`\<`Head`\>\] : \[`...Tail[]`\] *extends* \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] *extends* \[\] ? \[\] : \[`...Tail[]`\] *extends* \[`Head`\] ? \[`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>\] : \[`...Tail[]`\] *extends* \[`Head`, `...Tail[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : \[`...{ [K in (...)]: (...) }[]`\] : \[...\{ \[K in string \| number \| symbol\]: GetResults\<Tail\[K\]\> \}\[\]\] : \{ \[K in string \| number \| symbol\]: GetResults\<T\[K\]\> \}
99β
100## Parameters
101β
102### queriesOptions
103β
104`Accessor`\<\{
105 `combine?`: (`result`: `T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetResults`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] *extends* \[\] ? \[\] : \[`...Tail[]`\] *extends* \[`Head`\] ? \[`GetResults`\<...\>, `GetResults`\<...\>\] : \[`...(...)[]`\] *extends* \[..., `...(...)[]`\] ? ... *extends* ... ? ... : ... : \[`...(...)[]`\] : \{ \[K in string \| number \| symbol\]: GetResults\<T\[K\]\> \}) => `TCombinedResult`;
106 `queries`: \| readonly \[`T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetOptions`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] *extends* \[\] ? \[\] : \[`...Tail[]`\] *extends* \[`Head`\] ? \[`GetOptions`\<...\>, `GetOptions`\<...\>\] : \[`...(...)[]`\] *extends* \[..., `...(...)[]`\] ? ... *extends* ... ? ... : ... : ... *extends* ... ? ... : ... : readonly `unknown`[] *extends* `T` ? `T` : `T` *extends* `UseQueryOptionsForUseQueries`\<..., ..., ..., ...\>[] ? `UseQueryOptionsForUseQueries`\<..., ..., ..., ...\>[] : `UseQueryOptionsForUseQueries`\<..., ..., ..., ...\>[]\]
107 \| readonly \[\{ \[K in string \| number \| symbol\]: GetOptions\<T\[K\]\> \}\];
108\}\>
109β
110An accessor returning the `queries` array to run, and an optional `combine`
111function.
112β
113### queryClient?
114β
115`Accessor`\<[`QueryClient`](../classes/QueryClient.md)\>
116β
117An accessor for a custom `QueryClient`. Otherwise, the one from the nearest context
118will be used.
119β
120## Returns
121β
122`TCombinedResult`
123β
124The combined result. Without `combine`, this is an array with all the query results, in the same
125order as the input. When `combine` is provided, this is the value returned by `combine` instead.
126β
127## Examples
128β
129```tsx
130import { For } from 'solid-js'
131import { useQueries } from '@tanstack/solid-query'
132β
133function Posts(props: { ids: Array<number> }) {
134 const postQueries = useQueries(() => ({
135 queries: props.ids.map((id) => ({
136 queryKey: ['post', id],
137 queryFn: () => fetchPost(id),
138 staleTime: Infinity,
139 })),
140 }))
141β
142 return (
143 <ul>
144 <For each={postQueries}>
145 {(postQuery) => {
146 if (postQuery.isPending) return <li>Loading...</li>
147 if (postQuery.isError) return <li>Error: {postQuery.error.message}</li>
148 return <li>{postQuery.data.title}</li>
149 }}
150 </For>
151 </ul>
152 )
153}
154```
155β
156Combining results into a single value:
157```tsx
158import { For, Match, Switch } from 'solid-js'
159import { useQueries } from '@tanstack/solid-query'
160β
161function Posts(props: { ids: Array<number> }) {
162 const combinedPostsQuery = useQueries(() => ({
163 queries: props.ids.map((id) => ({
164 queryKey: ['post', id],
165 queryFn: () => fetchPost(id),
166 })),
167 combine: (postQueries) => {
168 return {
169 data: postQueries.map((postQuery) => postQuery.data),
170 isPending: postQueries.some((postQuery) => postQuery.isPending),
171 isError: postQueries.some((postQuery) => postQuery.isError),
172 }
173 },
174 }))
175β
176 return (
177 <Switch
178 fallback={
179 <ul>
180 <For each={combinedPostsQuery.data}>{(post) => <li>{post?.title}</li>}</For>
181 </ul>
182 }
183 >
184 <Match when={combinedPostsQuery.isPending}>Loading...</Match>
185 <Match when={combinedPostsQuery.isError}>Error loading posts</Match>
186 </Switch>
187 )
188}
189```