Skip to content

Commit 0dc7bc1

Browse files
docs (QueryClient): add entry for getQueriesData
1 parent cc328ed commit 0dc7bc1

File tree

1 file changed

+51
-24
lines changed

1 file changed

+51
-24
lines changed

docs/src/pages/reference/QueryClient.md

Lines changed: 51 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,30 +23,32 @@ await queryClient.prefetchQuery('posts', fetchPosts)
2323

2424
Its available methods are:
2525

26-
- [`fetchQuery`](#queryclientfetchquery)
27-
- [`fetchInfiniteQuery`](#queryclientfetchinfinitequery)
28-
- [`prefetchQuery`](#queryclientprefetchquery)
29-
- [`prefetchInfiniteQuery`](#queryclientprefetchinfinitequery)
30-
- [`getQueryData`](#queryclientgetquerydata)
31-
- [`setQueryData`](#queryclientsetquerydata)
32-
- [`setQueriesData`](#queryclientsetqueriesdata)
33-
- [`getQueryState`](#queryclientgetquerystate)
34-
- [`invalidateQueries`](#queryclientinvalidatequeries)
35-
- [`refetchQueries`](#queryclientrefetchqueries)
36-
- [`cancelQueries`](#queryclientcancelqueries)
37-
- [`removeQueries`](#queryclientremovequeries)
38-
- [`resetQueries`](#queryclientresetqueries)
39-
- [`isFetching`](#queryclientisfetching)
40-
- [`isMutating`](#queryclientismutating)
41-
- [`getDefaultOptions`](#queryclientsetdefaultoptions)
42-
- [`setDefaultOptions`](#queryclientgetdefaultoptions)
43-
- [`getQueryDefaults`](#queryclientgetquerydefaults)
44-
- [`setQueryDefaults`](#queryclientsetquerydefaults)
45-
- [`getMutationDefaults`](#queryclientgetmutationdefaults)
46-
- [`setMutationDefaults`](#queryclientsetmutationdefaults)
47-
- [`getQueryCache`](#queryclientgetquerycache)
48-
- [`getMutationCache`](#queryclientgetmutationcache)
49-
- [`clear`](#queryclientclear)
26+
- [`QueryClient`](#queryclient)
27+
- [`queryClient.fetchQuery`](#queryclientfetchquery)
28+
- [`queryClient.fetchInfiniteQuery`](#queryclientfetchinfinitequery)
29+
- [`queryClient.prefetchQuery`](#queryclientprefetchquery)
30+
- [`queryClient.prefetchInfiniteQuery`](#queryclientprefetchinfinitequery)
31+
- [`queryClient.getQueryData`](#queryclientgetquerydata)
32+
- [`queryClient.getQueriesData`](#queryclientgetqueriesdata)
33+
- [`queryClient.setQueryData`](#queryclientsetquerydata)
34+
- [`queryClient.getQueryState`](#queryclientgetquerystate)
35+
- [`queryClient.setQueriesData`](#queryclientsetqueriesdata)
36+
- [`queryClient.invalidateQueries`](#queryclientinvalidatequeries)
37+
- [`queryClient.refetchQueries`](#queryclientrefetchqueries)
38+
- [`queryClient.cancelQueries`](#queryclientcancelqueries)
39+
- [`queryClient.removeQueries`](#queryclientremovequeries)
40+
- [`queryClient.resetQueries`](#queryclientresetqueries)
41+
- [`queryClient.isFetching`](#queryclientisfetching)
42+
- [`queryClient.isMutating`](#queryclientismutating)
43+
- [`queryClient.getDefaultOptions`](#queryclientgetdefaultoptions)
44+
- [`queryClient.setDefaultOptions`](#queryclientsetdefaultoptions)
45+
- [`queryClient.getQueryDefaults`](#queryclientgetquerydefaults)
46+
- [`queryClient.setQueryDefaults`](#queryclientsetquerydefaults)
47+
- [`queryClient.getMutationDefaults`](#queryclientgetmutationdefaults)
48+
- [`queryClient.setMutationDefaults`](#queryclientsetmutationdefaults)
49+
- [`queryClient.getQueryCache`](#queryclientgetquerycache)
50+
- [`queryClient.getMutationCache`](#queryclientgetmutationcache)
51+
- [`queryClient.clear`](#queryclientclear)
5052

5153
**Options**
5254

@@ -175,6 +177,31 @@ const data = queryClient.getQueryData(queryKey)
175177
- `data: TData | undefined`
176178
- The data for the cached query, or `undefined` if the query does not exist.
177179

180+
## `queryClient.getQueriesData`
181+
182+
`getQueriesData` is a synchronous function that can be used to get the cached data of multiple queries. Only queries that match the passed queryKey or queryFilter will be returned. If there are no matching queries, an empty array will be returned.
183+
184+
```js
185+
const data = queryClient.getQueriesData(queryKey | filters)
186+
```
187+
188+
**Options**
189+
190+
- `queryKey: QueryKey`: [Query Keys](../guides/query-keys) | `filters: QueryFilters`: [Query Filters](../guides/filters#query-filters)
191+
- if a queryKey is passed as the argument, the data with queryKeys fuzzily matching this param will be returned
192+
- if a filter is passed, the data with queryKeys matching the filter will be returned
193+
194+
**Returns**
195+
196+
- `[queryKey:QueryKey, data:TData | unknown][]`
197+
- An array of tuples for the matched query keys, or `[]` if there are no matches. The tuples are the query key and its associated data.
198+
199+
**Caveats**
200+
201+
Because the returned data in each tuple can be of varying structures (i.e. using a filter to return "active" queries can return different data types), the `TData` generic defaults to `unknown`. If you provide a more specific type to `TData` it is assumed that you are certain each tuple's data entry is all the same type.
202+
203+
This distinction is more a "convenience" for ts devs that know which structure will be returned.
204+
178205
## `queryClient.setQueryData`
179206

180207
`setQueryData` is a synchronous function that can be used to immediately update a query's cached data. If the query does not exist, it will be created. **If the query is not utilized by a query hook in the default `cacheTime` of 5 minutes, the query will be garbage collected**.

0 commit comments

Comments
 (0)