Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useQueryClient.md

51 lines1.1 KB

function useQueryClient(id?: string): QueryClient;

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

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

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

const queryClient = useQueryClient()

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