MutationCache

Defined in: packages/query-core/src/mutationCache.ts:123

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:128

Parameters

config?

MutationCacheConfig = {}

Returns

MutationCache

Overrides

Subscribable<MutationCacheListener>.constructor

Properties

config

config: MutationCacheConfig = {};

Defined in: packages/query-core/src/mutationCache.ts:128

Methods

clear()

clear(): void;

Defined in: packages/query-core/src/mutationCache.ts:262

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:305

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

MutationFilters

The filters to match. exact defaults to true.

Returns

| Mutation<TData, TError, TVariables, TOnMutateResult> | undefined

The first matching mutation, or undefined.

See

MutationCache#findAll

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:336

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 = {}

The filters to match. Without filters, every mutation is returned.

Returns

Mutation<unknown, Error, unknown, unknown>[]

The matching mutations.

See

MutationCache#find

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:285

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>[]

Every mutation in the cache.

Example

const mutationCache = queryClient.getMutationCache()

const mutations = mutationCache.getAll()

hasListeners()

hasListeners(): boolean;

Defined in: packages/query-core/src/subscribable.ts:43

Returns true while at least one listener is registered, false once they have all unsubscribed.

Returns

boolean

true if at least one listener is registered.

Inherited from

Subscribable.hasListeners

subscribe()

subscribe(listener: MutationCacheListener): () => void;

Defined in: packages/query-core/src/subscribable.ts:28

Registers a listener to be called on every update this object notifies about. Returns a function that removes the listener again — call it to stop listening. The base class never drops a listener on its own, though some subclasses clear all of theirs in destroy().

Parameters

listener

MutationCacheListener

Called on each update, with whatever the subclass passes to its subscribers.

Returns

A function that removes the listener.

() => void

Example

const unsubscribe = subscribable.subscribe(() => {
  // react to the update
})

unsubscribe()

Inherited from

Subscribable.subscribe