Skip to content

docs(queryClient): JSDoc hint for queryClient.getQueryData #8862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TkDodo merged 3 commits into from
Mar 28, 2025
+7 −0
Merged

docs(queryClient): JSDoc hint for queryClient.getQueryData #8862

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bd0dee
docs(queryClient): JSDoc hint for queryClient.getQueryData
tylersayshi Mar 27, 2025
e8c7d1c
Update packages/query-core/src/queryClient.ts
TkDodo Mar 28, 2025
502eaa0
Update packages/query-core/src/queryClient.ts
TkDodo Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/query-core/src/queryClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down