useQueryClient

1function useQueryClient(id?: string): QueryClient;

定义于：packages/vue-query/src/useQueryClient.ts:27

通过 Vue 的 inject 获取由 VueQueryPlugin 安装的 QueryClient。必须在 setup() 或另一个支持注入上下文的函数内调用。

参数

id?

string = ''

传给 VueQueryPlugin 的 queryClientKey —— 仅当同一应用中安装了多个 QueryClient 时才需要指定。

返回值

QueryClient

已安装的 QueryClient。

抛出异常

若在注入上下文之外调用，或未通过 VueQueryPlugin 安装 QueryClient，则抛出异常。

示例

1<script setup lang="ts">2import { useQueryClient } from '@tanstack/vue-query'34const queryClient = useQueryClient()56function invalidate() {7  queryClient.invalidateQueries({ queryKey: ['todos'] })8}9</script>