mirror of
https://github.com/TanStack/query.git
synced 2026-11-18 19:33:22 +00:00
* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones * docs(*): link to the base type's properties when a parameter or result type has no property table * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs * chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines' * docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
1.6 KiB
1.6 KiB
| id | title | redirect_from | |
|---|---|---|---|
| useIsMutating | useIsMutating |
|
function useIsMutating(filters?: Accessor<MutationFilters<unknown, Error, unknown, unknown>>, queryClient?: Accessor<QueryClient>): Accessor<number>;
Defined in: packages/solid-query/src/useIsMutating.ts:26
The useIsMutating primitive returns the number of mutations that your application currently has pending
(useful for app-wide loading indicators).
Parameters
filters?
Accessor<MutationFilters<unknown, Error, unknown, unknown>>
An accessor returning the MutationFilters to narrow down the matched mutations.
filters properties
Built from MutationFilters. See the type above for what it changes.
queryClient?
Accessor<QueryClient>
An accessor for a custom QueryClient. Otherwise, the one from the nearest context
will be used.
Returns
Accessor<number>
An accessor for the number of the mutations that your application currently has pending.
Example
import { useIsMutating } from '@tanstack/solid-query'
function PostsMutatingIndicator() {
// How many mutations matching the posts prefix are in progress?
const isMutatingPosts = useIsMutating(() => ({ mutationKey: ['posts'] }))
return isMutatingPosts() > 0 ? <span>Saving posts...</span> : null
}