useIsMutating

function useIsMutating(filters?, queryClient?): number;

Defined in: preact-query/src/useMutationState.ts:35

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

Parameters#

filters?#

MutationFilters<unknown, Error, unknown, unknown>

The MutationFilters to narrow down the matched mutations.

queryClient?#

QueryClient

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

Returns#

number

Will be the number of the mutations that your application is currently fetching.

Example#

import { useIsMutating } from '@tanstack/preact-query'

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

  return isMutatingPosts ? <span>Saving posts...</span> : null
}