mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
985 B
985 B
| id | title |
|---|---|
| useQueryClient | useQueryClient |
function useQueryClient(id): QueryClient;
Defined in: packages/vue-query/src/useQueryClient.ts:27
Retrieves the QueryClient installed by VueQueryPlugin, via Vue's inject. Must be called inside
setup() or another function that supports an injection context.
Parameters
id
string = ''
The queryClientKey passed to VueQueryPlugin — only needed when multiple QueryClients are
installed in the same app.
Returns
Throws
If called outside an injection context, or if no QueryClient was installed via VueQueryPlugin.
Example
<script setup lang="ts">
import { useQueryClient } from '@tanstack/vue-query'
const queryClient = useQueryClient()
function invalidate() {
queryClient.invalidateQueries({ queryKey: ['todos'] })
}
</script>