diff --git a/packages/query-core/src/queryClient.ts b/packages/query-core/src/queryClient.ts index f9f15543dca..b63d4fd004f 100644 --- a/packages/query-core/src/queryClient.ts +++ b/packages/query-core/src/queryClient.ts @@ -119,6 +119,13 @@ export class QueryClient { return this.#mutationCache.findAll({ ...filters, status: 'pending' }).length } + /** + * Imperative (non-reactive) way to retrieve data for a QueryKey. + * Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates. + * + * Hint: Do not use this function inside a component, because it won't receive updates. + * Use `useQuery` to create a `QueryObserver` that subscribes to changes. + */ getQueryData< TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey,