0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/vue/reference/functions/useQueryClient.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

1 KiB

id title redirect_from
useQueryClient useQueryClient
framework/vue/reference/useQueryClient
function useQueryClient(id: string): QueryClient;

Defined in: packages/vue-query/src/useQueryClient.ts:25

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

QueryClient

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>