TanStack
API Reference

MutationFilters

Defined in: packages/query-core/src/utils.ts:63

Filters used to select mutations, for example in mutationCache.findAll or queryClient.isMutating. All provided filters must match; filters that are left unspecified are ignored.

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

TVariables

TVariables = unknown

TOnMutateResult

TOnMutateResult = unknown

Properties

PropertyTypeDescription
exact?booleanMatch mutation key exactly
mutationKey?readonly unknown[]Include mutations matching this mutation key
predicate?(mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => booleanInclude mutations matching this predicate function
status?"error" | "pending" | "success" | "idle"Filter by mutation status