katanakit-js / MutationCache

Class: MutationCache

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:616

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?): MutationCache;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:619

Parameters

Parameter	Type
config?	MutationCacheConfig

Returns

MutationCache

Overrides

Subscribable<MutationCacheListener>.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
config	public	MutationCacheConfig	-	node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:618
listeners	protected	Set<MutationCacheListener>	Subscribable.listeners	node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/subscribable-CysQ0tne.d.ts:8

Methods

clear()

clear(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:640

Removes all mutations from the cache.

Returns

void

Example

const mutationCache = queryClient.getMutationCache()

mutationCache.clear()

---

find()

find<TData, TError, TVariables, TOnMutateResult>(filters): 
  | Mutation<TData, TError, TVariables, TOnMutateResult>
  | undefined;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:670

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

Type Parameter	Default type
TData	unknown
TError	Error
TVariables	any
TOnMutateResult	unknown

Parameters

Parameter	Type
filters	MutationFilters

Returns

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

See

MutationCache#findAll

Example

const mutationCache = queryClient.getMutationCache()

const mutation = mutationCache.find({ mutationKey: ['addPost'] })

---

findAll()

findAll(filters?): Mutation<unknown, Error, unknown, unknown>[];

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:686

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

Parameter	Type
filters?	MutationFilters<unknown, Error, unknown, unknown>

Returns

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

See

MutationCache#find

Example

const mutationCache = queryClient.getMutationCache()

const mutations = mutationCache.findAll({ mutationKey: ['addPost'] })

---

getAll()

getAll(): Mutation<unknown, Error, unknown, unknown>[];

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:654

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: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/subscribable-CysQ0tne.d.ts:28

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

Returns

boolean

Inherited from

Subscribable.hasListeners

---

onSubscribe()

protected onSubscribe(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/subscribable-CysQ0tne.d.ts:29

Returns

void

Inherited from

Subscribable.onSubscribe

---

onUnsubscribe()

protected onUnsubscribe(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/subscribable-CysQ0tne.d.ts:30

Returns

void

Inherited from

Subscribable.onUnsubscribe

---

subscribe()

subscribe(listener): () => void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/subscribable-CysQ0tne.d.ts:24

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

Parameter	Type	Description
listener	MutationCacheListener	Called on each update, with whatever the subclass passes to its subscribers.

Returns

() => void

Example

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

unsubscribe()

Inherited from

Subscribable.subscribe