useQueryClient

function useQueryClient(id?: string): QueryClient;

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

The installed QueryClient.

Throws

If called outside an injection context, or if no QueryClient was installed via VueQueryPlugin.

Example

vue

<script setup lang="ts">
import { useQueryClient } from '@tanstack/vue-query'

const queryClient = useQueryClient()

function invalidate() {
  queryClient.invalidateQueries({ queryKey: ['todos'] })
}
</script>

<script setup lang="ts">
import { useQueryClient } from '@tanstack/vue-query'

const queryClient = useQueryClient()

function invalidate() {
  queryClient.invalidateQueries({ queryKey: ['todos'] })
}
</script>

Parameters

id?

Returns

Throws

Example

Want to Skip the Docs?