API Reference

useIsMutating

useIsMutating is an optional hook that returns the number of mutations that your application is currently in a pending state with (useful for app-wide loading indicators).

tsx
import { useIsMutating } from '@tanstack/solid-query'
// How many mutations are pending?
const isMutating = useIsMutating()
isMutating()
// How many mutations matching the posts prefix are pending?
const isMutatingPosts = useIsMutating(() => ({ mutationKey: ['posts'] }))
isMutatingPosts()

Options

  • filters?: Accessor<MutationFilters>: Mutation Filters

  • queryClient?: Accessor<QueryClient>

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

      Returns

  • isMutating: Accessor<number>

    • Will resolve to the number of the mutations that your application is currently pending with.