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

useIsMutating.md

60 lines2.0 KB

1---
2id: useIsMutating
3title: useIsMutating
4redirect_from:
5 - framework/react/reference/useIsMutating
6---
7​
8```ts
9function useIsMutating(filters?: MutationFilters<unknown, Error, unknown, unknown>, queryClient?: QueryClient): number;
10```
11​
12Defined in: [packages/react-query/src/useMutationState.ts:33](https://github.com/TanStack/query/blob/main/packages/react-query/src/useMutationState.ts#L33)
13​
14The `useIsMutating` hook returns the `number` of mutations that your application currently has `pending`
15(useful for app-wide loading indicators).
16​
17## Parameters
18​
19### filters?
20​
21[`MutationFilters`](../interfaces/MutationFilters.md)\<`unknown`, `Error`, `unknown`, `unknown`\>
22​
23The [MutationFilters](../interfaces/MutationFilters.md) to narrow down the matched mutations.
24​
25<a id="filters-properties"></a>
26​
27#### `filters` properties
28​
29| Property | Type | Description |
30| ------ | ------ | ------ |
31| <a id="filters-property-exact"></a> `exact?` | `boolean` | Match mutation key exactly |
32| <a id="filters-property-mutationkey"></a> `mutationKey?` | readonly `unknown`[] | Include mutations matching this mutation key |
33| <a id="filters-property-predicate"></a> `predicate?` | (`mutation`: [`Mutation`](../classes/Mutation.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>) => `boolean` | Include mutations matching this predicate function |
34| <a id="filters-property-status"></a> `status?` | `"error"` \| `"pending"` \| `"success"` \| `"idle"` | Filter by mutation status |
35​
36### queryClient?
37​
38[`QueryClient`](../classes/QueryClient.md)
39​
40Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
41be used.
42​
43## Returns
44​
45`number`
46​
47Will be the `number` of the mutations that your application currently has `pending`.
48​
49## Example
50​
51```tsx
52import { useIsMutating } from '@tanstack/react-query'
53​
54function PostsMutatingIndicator() {
55 // How many mutations matching the posts prefix are in progress?
56 const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
57​
58 return isMutatingPosts ? <span>Saving posts...</span> : null
60```