Defined in: packages/vue-query/src/mutationCache.ts:15
Vue-aware subclass of @tanstack/query-core's MutationCache. find/findAll also accept a MaybeRefDeep filters object, so refs can be passed directly without unwrapping. Access it via queryClient.getMutationCache() — QueryClient constructs one of these by default.
new MutationCache(config: MutationCacheConfig): MutationCache;
new MutationCache(config: MutationCacheConfig): MutationCache;
Defined in: packages/query-core/src/mutationCache.ts:129
MutationCacheConfig = {}
MutationCache
MC.constructor
MC.constructor
config: MutationCacheConfig = {};
config: MutationCacheConfig = {};
Defined in: packages/query-core/src/mutationCache.ts:129
MC.config
MC.config
protected listeners: Set<MutationCacheListener>;
protected listeners: Set<MutationCacheListener>;
Defined in: packages/query-core/src/subscribable.ts:2
MC.listeners
MC.listeners
clear(): void;
clear(): void;
Defined in: packages/query-core/src/mutationCache.ts:236
Removes all mutations from the cache.
void
const mutationCache = queryClient.getMutationCache()
mutationCache.clear()
const mutationCache = queryClient.getMutationCache()
mutationCache.clear()
MC.clear
MC.clear
find<TData, TError, TVariables, TOnMutateResult>(filters: MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>>):
| Mutation<TData, TError, TVariables, TOnMutateResult>
| undefined;
find<TData, TError, TVariables, TOnMutateResult>(filters: MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>>):
| Mutation<TData, TError, TVariables, TOnMutateResult>
| undefined;
Defined in: packages/vue-query/src/mutationCache.ts:16
A slightly more advanced method that can be used to get an existing mutation instance from the cache. If the mutation does not exist, undefined is returned.
This is not typically needed for most applications, but can come in handy when needing more information about a mutation in rare scenarios.
TData = unknown
TError = Error
TVariables = any
TOnMutateResult = unknown
MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>>
| Mutation<TData, TError, TVariables, TOnMutateResult> | undefined
const mutationCache = queryClient.getMutationCache()
const mutation = mutationCache.find({ mutationKey: ['addPost'] })
const mutationCache = queryClient.getMutationCache()
const mutation = mutationCache.find({ mutationKey: ['addPost'] })
MC.find
MC.find
findAll(filters: MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>>): Mutation<unknown, Error, unknown, unknown>[];
findAll(filters: MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>>): Mutation<unknown, Error, unknown, unknown>[];
Defined in: packages/vue-query/src/mutationCache.ts:27
An even more advanced method that can be used to get existing mutation instances from the cache that match the given filters. If no mutations match, an empty array is returned.
This is not typically needed for most applications, but can come in handy when needing more information about mutations in rare scenarios.
MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>> = {}
Mutation<unknown, Error, unknown, unknown>[]
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.findAll({ mutationKey: ['addPost'] })
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.findAll({ mutationKey: ['addPost'] })
MC.findAll
MC.findAll
getAll(): Mutation<unknown, Error, unknown, unknown>[];
getAll(): Mutation<unknown, Error, unknown, unknown>[];
Defined in: packages/query-core/src/mutationCache.ts:259
Returns all mutations within the cache.
This is not typically needed for most applications, but can come in handy when needing more information about a mutation in rare scenarios.
Mutation<unknown, Error, unknown, unknown>[]
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.getAll()
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.getAll()
MC.getAll
MC.getAll
hasListeners(): boolean;
hasListeners(): boolean;
Defined in: packages/query-core/src/subscribable.ts:19
boolean
MC.hasListeners
MC.hasListeners
protected onSubscribe(): void;
protected onSubscribe(): void;
Defined in: packages/query-core/src/subscribable.ts:23
void
MC.onSubscribe
MC.onSubscribe
protected onUnsubscribe(): void;
protected onUnsubscribe(): void;
Defined in: packages/query-core/src/subscribable.ts:27
void
MC.onUnsubscribe
MC.onUnsubscribe
subscribe(listener: MutationCacheListener): () => void;
subscribe(listener: MutationCacheListener): () => void;
Defined in: packages/query-core/src/subscribable.ts:8
MutationCacheListener
(): void;
(): void;
void
MC.subscribe
MC.subscribe