0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/solid/reference/useIsMutating.md
Wonsuk Choi 4c568a28c8
docs(react-query): generate reference docs with TypeDoc (#11366)
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs

* docs(react-query): generate reference docs with TypeDoc

* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy

* docs(solid-query): apply solid's callback call form to inlined reference examples

* docs(react-query): correct inaccurate JSDoc statements flagged in review

* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review

* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review

* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does

* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
2026-09-02 16:06:54 +09:00

927 B

id title
useIsMutating 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).

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.