mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* 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
1.1 KiB
1.1 KiB
| id | title |
|---|---|
| useIsMutating | useIsMutating |
function useIsMutating(filters?, queryClient?): number;
Defined in: react-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/react-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
}