useIsMutating

function useIsMutating(filters?: MutationFilters<unknown, Error, unknown, unknown>, queryClient?: QueryClient): ReactiveValue<number>;

Defined in: packages/svelte-query/src/useIsMutating.svelte.ts:26

useIsMutating is an optional function that returns the number of mutations that your application is running (useful for app-wide loading indicators).

Parameters

filters?

MutationFilters<unknown, Error, unknown, unknown>

MutationFilters to narrow down which mutations to count.

filters properties

Property	Type	Description
exact?	boolean	Match mutation key exactly
mutationKey?	readonly unknown[]	Include mutations matching this mutation key
predicate?	(mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean	Include mutations matching this predicate function
status?	"error" \| "pending" \| "success" \| "idle"	Filter by mutation status

queryClient?

QueryClient

Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used.

Returns

ReactiveValue<number>

A reactive value — read .current to get how many matching mutations are currently running.

Example

svelte

<script lang="ts">
  import { useIsMutating } from '@tanstack/svelte-query'

  // How many mutations matching the posts prefix are in progress?
  const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
</script>

{#if isMutatingPosts.current}
  <span>Saving posts...</span>
{/if}