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

useIsMutating.md

57 lines1.6 KB

function useIsMutating(filters?: Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">, 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?

Omit<MutationFilters<unknown, Error, unknown, unknown>, "status">

MutationFilters to narrow down which mutations to count.

filters properties

Built from MutationFilters. See the type above for what it changes.

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

<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}