0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/vue/reference/functions/useQueryClient.md
Wonsuk Choi ac3256ad0d
docs(vue-query): redirect flat reference URLs broken by the TypeDoc migration (#11398)
docs(config): register redirect_from mappings for vue-query reference pages
2026-09-24 11:57:53 +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: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

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>