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

useIsMutating

更新于 2026-11-02 Lit 查看英文原文 ↗
TypeScript
1function useIsMutating(2   host: ReactiveControllerHost,3   filters?: Accessor<Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">>,4   queryClient?: QueryClient5): IsMutatingAccessor;

定义于:packages/lit-query/src/useIsMutating.ts:141

创建一个 Lit 响应式控制器,用于跟踪当前处于等待中(pending)状态的、匹配的修改(mutations)数量。

当 filters 是一个函数时,它会在宿主(host)更新期间被重新读取,以便计数能跟随宿主的响应式状态变化。如果省略 queryClient,该控制器会从最近连接的 QueryClientProvider 中解析出查询客户端(query client)。

参数

host

ReactiveControllerHost

拥有缓存订阅(cache subscription)的 Lit 响应式控制器宿主。

filters?

Accessor<Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">> = {}

修改过滤器,或一个返回修改过滤器的 getter 函数。

filters 的属性

基于 MutationFilters 构建。请参阅上方类型定义以了解其具体影响。

queryClient?

QueryClient

可选的显式查询客户端(query client)。对于不应从 Lit 上下文解析查询客户端的控制器,请提供此参数。

返回值

IsMutatingAccessor

一个用于访问当前匹配的等待中修改数量的访问器(accessor)。

示例

TypeScript
1import { LitElement, html } from 'lit'2import { useIsMutating } from '@tanstack/lit-query'3 4class MutationStatus extends LitElement {5  private readonly savesPending = useIsMutating(this, {6    mutationKey: ['save-project'],7  })8 9  render() {10    return html`<span>${this.savesPending()} saves pending</span>`11  }12}

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

译自上游 59d11de