Defined in: packages/query-core/src/mutationCache.ts:124
The MutationCache is the storage for mutations.
Normally, you will not interact with the MutationCache directly and instead use a
QueryClient. You can subscribe to it (inherited from Subscribable) to be informed of
safe/known updates to the cache, such as mutations being added, removed, or updated.
Example#
const unsubscribe = mutationCache.subscribe((event) => {
console.log(event.type, event.mutation)
})
Extends#
Subscribable<MutationCacheListener>
Constructors#
Constructor#
new MutationCache(config: MutationCacheConfig): MutationCache;
Defined in: packages/query-core/src/mutationCache.ts:129
Parameters#
config#
MutationCacheConfig = {}
Returns#
MutationCache
Overrides#
Subscribable<MutationCacheListener>.constructor
Properties#
config#
config: MutationCacheConfig = {};
Defined in: packages/query-core/src/mutationCache.ts:129
listeners#
protected listeners: Set<MutationCacheListener>;
Defined in: packages/query-core/src/subscribable.ts:2
Inherited from#
Subscribable.listeners
Methods#
clear()#
clear(): void;
Defined in: packages/query-core/src/mutationCache.ts:236
Removes all mutations from the cache.
Returns#
void
Example#
const mutationCache = queryClient.getMutationCache()
mutationCache.clear()
find()#
find<TData, TError, TVariables, TOnMutateResult>(filters: MutationFilters):
| Mutation<TData, TError, TVariables, TOnMutateResult>
| undefined;
Defined in: packages/query-core/src/mutationCache.ts:278
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.
Type Parameters#
TData#
TData = unknown
TError#
TError = Error
TVariables#
TVariables = any
TOnMutateResult#
TOnMutateResult = unknown
Parameters#
filters#
Returns#
| Mutation<TData, TError, TVariables, TOnMutateResult>
| undefined
See#
Example#
const mutationCache = queryClient.getMutationCache()
const mutation = mutationCache.find({ mutationKey: ['addPost'] })
findAll()#
findAll(filters: MutationFilters): Mutation<unknown, Error, unknown, unknown>[];
Defined in: packages/query-core/src/mutationCache.ts:308
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.
Parameters#
filters#
MutationFilters = {}
Returns#
Mutation<unknown, Error, unknown, unknown>[]
See#
Example#
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.findAll({ mutationKey: ['addPost'] })
getAll()#
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.
Returns#
Mutation<unknown, Error, unknown, unknown>[]
Example#
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.getAll()
hasListeners()#
hasListeners(): boolean;
Defined in: packages/query-core/src/subscribable.ts:19
Returns#
boolean
Inherited from#
Subscribable.hasListeners
onSubscribe()#
protected onSubscribe(): void;
Defined in: packages/query-core/src/subscribable.ts:23
Returns#
void
Inherited from#
Subscribable.onSubscribe
onUnsubscribe()#
protected onUnsubscribe(): void;
Defined in: packages/query-core/src/subscribable.ts:27
Returns#
void
Inherited from#
Subscribable.onUnsubscribe
subscribe()#
subscribe(listener: MutationCacheListener): () => void;
Defined in: packages/query-core/src/subscribable.ts:8
Parameters#
listener#
MutationCacheListener
Returns#
(): void;
Returns#
void
Inherited from#
Subscribable.subscribe