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
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8```ts
9function useIsMutating(filters?: Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">, queryClient?: QueryClient): ReactiveValue<number>;
10```
11​
12Defined in: [packages/svelte-query/src/useIsMutating.svelte.ts:26](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsMutating.svelte.ts#L26)
13​
14`useIsMutating` is an optional function that returns the `number` of mutations that your application is
15running (useful for app-wide loading indicators).
16​
17## Parameters
18​
19### filters?
20​
21`Omit`\<[`MutationFilters`](../interfaces/MutationFilters.md)\<`unknown`, `Error`, `unknown`, `unknown`\>, `"status"`\>
22​
23[MutationFilters](../interfaces/MutationFilters.md) to narrow down which mutations to count.
24​
25<a id="filters-properties"></a>
26​
27#### `filters` properties
28​
29Built from [`MutationFilters`](../interfaces/MutationFilters.md#properties). See the type above for what it changes.
30​
31### queryClient?
32​
33[`QueryClient`](../classes/QueryClient.md)
34​
35Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
36be used.
37​
38## Returns
39​
40`ReactiveValue`\<`number`\>
41​
42A reactive value β€” read `.current` to get how many matching mutations are currently running.
43​
44## Example
45​
46```svelte
47<script lang="ts">
48 import { useIsMutating } from '@tanstack/svelte-query'
49​
50 // How many mutations matching the posts prefix are in progress?
51 const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
52</script>
53​
54{#if isMutatingPosts.current}
55 <span>Saving posts...</span>
56{/if}
57```