snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)

docs/framework/angular/reference/classes/MutationCache.md

@@ -0,0 +1,316 @@
+---
+id: MutationCache
+title: MutationCache
+---
+
+Defined in: [packages/query-core/src/mutationCache.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L124)
+
+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
+
+```ts
+const unsubscribe = mutationCache.subscribe((event) => {
+  console.log(event.type, event.mutation)
+})
+```
+
+## Extends
+
+- `Subscribable`\<`MutationCacheListener`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new MutationCache(config): MutationCache;
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129)
+
+#### Parameters
+
+##### config
+
+[`MutationCacheConfig`](../interfaces/MutationCacheConfig.md) = `{}`
+
+#### Returns
+
+`MutationCache`
+
+#### Overrides
+
+```ts
+Subscribable<MutationCacheListener>.constructor
+```
+
+## Properties
+
+### config
+
+```ts
+config: MutationCacheConfig = {};
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129)
+
+***
+
+### listeners
+
+```ts
+protected listeners: Set<MutationCacheListener>;
+```
+
+Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2)
+
+#### Inherited from
+
+```ts
+Subscribable.listeners
+```
+
+## Methods
+
+### clear()
+
+```ts
+clear(): void;
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:236](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L236)
+
+Removes all mutations from the cache.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const mutationCache = queryClient.getMutationCache()
+
+mutationCache.clear()
+```
+
+***
+
+### find()
+
+```ts
+find<TData, TError, TVariables, TOnMutateResult>(filters): 
+  | Mutation<TData, TError, TVariables, TOnMutateResult>
+  | undefined;
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L278)
+
+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`](../interfaces/MutationFilters.md)
+
+#### Returns
+
+  \| [`Mutation`](Mutation.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
+  \| `undefined`
+
+#### See
+
+[MutationCache#findAll](#findall)
+
+#### Example
+
+```ts
+const mutationCache = queryClient.getMutationCache()
+
+const mutation = mutationCache.find({ mutationKey: ['addPost'] })
+```
+
+***
+
+### findAll()
+
+```ts
+findAll(filters): Mutation<unknown, Error, unknown, unknown>[];
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:308](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L308)
+
+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`](../interfaces/MutationFilters.md) = `{}`
+
+#### Returns
+
+[`Mutation`](Mutation.md)\<`unknown`, `Error`, `unknown`, `unknown`\>[]
+
+#### See
+
+[MutationCache#find](#find)
+
+#### Example
+
+```ts
+const mutationCache = queryClient.getMutationCache()
+
+const mutations = mutationCache.findAll({ mutationKey: ['addPost'] })
+```
+
+***
+
+### getAll()
+
+```ts
+getAll(): Mutation<unknown, Error, unknown, unknown>[];
+```
+
+Defined in: [packages/query-core/src/mutationCache.ts:259](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L259)
+
+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`](Mutation.md)\<`unknown`, `Error`, `unknown`, `unknown`\>[]
+
+#### Example
+
+```ts
+const mutationCache = queryClient.getMutationCache()
+
+const mutations = mutationCache.getAll()
+```
+
+***
+
+### hasListeners()
+
+```ts
+hasListeners(): boolean;
+```
+
+Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+```ts
+Subscribable.hasListeners
+```
+
+***
+
+### onSubscribe()
+
+```ts
+protected onSubscribe(): void;
+```
+
+Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+Subscribable.onSubscribe
+```
+
+***
+
+### onUnsubscribe()
+
+```ts
+protected onUnsubscribe(): void;
+```
+
+Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+Subscribable.onUnsubscribe
+```
+
+***
+
+### subscribe()
+
+```ts
+subscribe(listener): () => void;
+```
+
+Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8)
+
+#### Parameters
+
+##### listener
+
+`MutationCacheListener`
+
+#### Returns
+
+```ts
+(): void;
+```
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+Subscribable.subscribe
+```