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

useIsMutating.md

57 lines1.6 KB

1---
2id: useIsMutating
3title: useIsMutating
4redirect_from:
5 - framework/react/reference/useIsMutating
6---
7​
8<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
9​
10```ts
11function useIsMutating(filters?: Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">, queryClient?: QueryClient): number;
12```
13​
14Defined in: [packages/react-query/src/useMutationState.ts:33](https://github.com/TanStack/query/blob/main/packages/react-query/src/useMutationState.ts#L33)
15​
16The `useIsMutating` hook returns the `number` of mutations that your application currently has `pending`
17(useful for app-wide loading indicators).
18​
19## Parameters
20​
21### filters?
22​
23`Omit`\<[`MutationFilters`](../interfaces/MutationFilters.md)\<`unknown`, `Error`, `unknown`, `unknown`\>, `"status"`\>
24​
25The [MutationFilters](../interfaces/MutationFilters.md) to narrow down the matched mutations.
26​
27<a id="filters-properties"></a>
28​
29#### `filters` properties
30​
31Built from [`MutationFilters`](../interfaces/MutationFilters.md#properties). See the type above for what it changes.
32​
33### queryClient?
34​
35[`QueryClient`](../classes/QueryClient.md)
36​
37Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
38be used.
39​
40## Returns
41​
42`number`
43​
44Will be the `number` of the mutations that your application currently has `pending`.
45​
46## Example
47​
48```tsx
49import { useIsMutating } from '@tanstack/react-query'
50​
51function PostsMutatingIndicator() {
52 // How many mutations matching the posts prefix are in progress?
53 const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
54​
55 return isMutatingPosts ? <span>Saving posts...</span> : null
57```