译零 TransZero · TanStack Query 中文文档
主站

useIsMutating

更新于 2026-11-02 React 查看英文原文 ↗
TypeScript
1function useIsMutating(filters?: Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">, queryClient?: QueryClient): number;

定义于:packages/react-query/src/useMutationState.ts:33

useIsMutating Hook 返回你的应用当前正在执行的修改(mutations)的数量(适用于全应用范围的加载指示器)。

参数

filters?

Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">

用于缩小匹配范围的 MutationFilters。

filters 属性

基于 MutationFilters 构建。具体可更改的字段请参见上方类型定义。

queryClient?

QueryClient

使用该参数可指定自定义的 QueryClient;否则将使用离当前组件最近的上下文中的 QueryClient。

返回值

number

返回你的应用当前正在执行的修改(mutations)的数量。

示例

TypeScript
1import { useIsMutating } from '@tanstack/react-query'2 3function PostsMutatingIndicator() {4  // How many mutations matching the posts prefix are in progress?5  const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })6 7  return isMutatingPosts ? <span>Saving posts...</span> : null8}

本页为 TanStack Query 文档(React 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

译自上游 59d11de