mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.4 KiB
1.4 KiB
| id | title |
|---|---|
| useIsMutating | useIsMutating |
function useIsMutating(filters, queryClient?): Ref<number>;
Defined in: packages/vue-query/src/useMutationState.ts:49
The useIsMutating composable returns a ref to the number of mutations that your application currently
has pending (useful for app-wide loading indicators).
filters may be a plain object, MaybeRefDeep, or a reactive getter (() => ({ ... })) — pass a getter if
the filters themselves depend on other reactive state.
Parameters
filters
The MutationFilters to narrow down the matched mutations.
MutationFilters | () => MutationFilters
queryClient?
Use this to use a custom QueryClient. Otherwise, the one provided by VueQueryPlugin
will be used.
Returns
Ref<number>
A ref to the number of the mutations that your application currently has pending.
Example
<script setup lang="ts">
import { useIsMutating } from '@tanstack/vue-query'
// How many mutations matching the posts prefix are in progress?
const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
</script>
<template>
<span v-if="isMutatingPosts">Saving posts...</span>
</template>