Open History to see the last commit
1---
2id: mutationOptions
3title: mutationOptions
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8## Overview
9β
10```ts
11function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
12function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
13```
14β
15- [`WithRequired<CreateMutationOptions>` β `WithRequired<CreateMutationOptions>`](#call-signature-1): You can generally pass everything to `mutationOptions` that you can also pass to `injectMutation`. A `mutationKey` is required on this overload so the mutation can be looked up later, e.g. with `injectMutationState`.
16- [`Omit<CreateMutationOptions>` β `Omit<CreateMutationOptions>`](#call-signature-2): You can generally pass everything to `mutationOptions` that you can also pass to `injectMutation`. No `mutationKey` is required on this overload β use this when you don't need to target the mutation via a `mutationKey` filter later (e.g. with `injectMutationState`); it can still be observed through other filters, such as `status`.
17β
18See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
19β
20<a id="call-signature-1"></a>
21β
22## Call Signature
23β
24```ts
25function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
26```
27β
28Defined in: [packages/angular-query/src/mutation-options.ts:38](https://github.com/TanStack/query/blob/main/packages/angular-query/src/mutation-options.ts#L38)
29β
30You can generally pass everything to `mutationOptions` that you can also pass to `injectMutation`. A
31`mutationKey` is required on this overload so the mutation can be looked up later, e.g. with
32`injectMutationState`.
33β
34### Type Parameters
35β
36#### TData
37β
38`TData` = `unknown`
39β
40#### TError
41β
42`TError` = `Error`
43β
44#### TVariables
45β
46`TVariables` = `void`
47β
48#### TOnMutateResult
49β
50`TOnMutateResult` = `unknown`
51β
52### Parameters
53β
54#### options
55β
56[`WithRequired`](../type-aliases/WithRequired.md)\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
57β
58The mutation options to use, identical to what you'd pass to `injectMutation`, with a
59required `mutationKey`.
60β
61### Returns
62β
63[`WithRequired`](../type-aliases/WithRequired.md)\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
64β
65The same options object, unchanged.
66β
67### See
68β
69[injectMutation](injectMutation.md) to run the mutation these options describe.
70β
71### Example
72β
73Looking the mutation up elsewhere via its `mutationKey`, e.g. for a global "savingβ¦" indicator:
74```angular-ts
75import { mutationOptions, injectMutationState } from '@tanstack/angular-query'
76β
77const createPostOptions = mutationOptions({
78 mutationKey: ['posts', 'create'],
79 mutationFn: createPost,
80})
81β
82@Component({
83 selector: 'saving-indicator',
84 template: `
85 @if (isCreatingPost()) {
86 <span>Savingβ¦</span>
87 }
88 `,
89})
90export class SavingIndicator {
91 readonly #pendingCreates = injectMutationState(() => ({
92 filters: { mutationKey: createPostOptions.mutationKey, status: 'pending' },
93 }))
94 readonly isCreatingPost = computed(() => this.#pendingCreates().length > 0)
95}
96```
97β
98<a id="call-signature-2"></a>
99β
100## Call Signature
101β
102```ts
103function mutationOptions<TData = unknown, TError = Error, TVariables = void, TOnMutateResult = unknown>(options: Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">): Omit<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">;
104```
105β
106Defined in: [packages/angular-query/src/mutation-options.ts:94](https://github.com/TanStack/query/blob/main/packages/angular-query/src/mutation-options.ts#L94)
107β
108You can generally pass everything to `mutationOptions` that you can also pass to `injectMutation`. No
109`mutationKey` is required on this overload β use this when you don't need to target the mutation via a
110`mutationKey` filter later (e.g. with `injectMutationState`); it can still be observed through other
111filters, such as `status`.
112β
113### Type Parameters
114β
115#### TData
116β
117`TData` = `unknown`
118β
119#### TError
120β
121`TError` = `Error`
122β
123#### TVariables
124β
125`TVariables` = `void`
126β
127#### TOnMutateResult
128β
129`TOnMutateResult` = `unknown`
130β
131### Parameters
132β
133#### options
134β
135`Omit`\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
136β
137The mutation options to use, identical to what you'd pass to `injectMutation`, without a
138`mutationKey`.
139β
140### Returns
141β
142`Omit`\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
143β
144The same options object, unchanged.
145β
146### Remarks
147β
148See the other overload's example for looking a mutation up via `injectMutationState`.
149β
150### See
151β
152[injectMutation](injectMutation.md) to run the mutation these options describe.
153β
154### Example
155β
156Sharing options across services, so `QueriesService` stays the single place a mutation is defined:
157```angular-ts
158import { mutationOptions, injectMutation } from '@tanstack/angular-query'
159β
160@Injectable({ providedIn: 'root' })
161export class QueriesService {
162 readonly #queryClient = inject(QueryClient)
163β
164 updatePost(id: number) {
165 return mutationOptions({
166 mutationFn: (post: Partial<Post>) => putPost(id, post),
167 onSuccess: (newPost) => this.#queryClient.setQueryData(['posts', id], newPost),
168 })
169 }
170}
171β
172@Component({
173 selector: 'post',
174 template: `<button (click)="save()">Save</button>`,
175})
176export class Post {
177 readonly queries = inject(QueriesService)
178 readonly id = signal(0)
179 readonly updatePostMutation = injectMutation(() => this.queries.updatePost(this.id()))
180β
181 save() {
182 this.updatePostMutation.mutate({ title: 'New Title' })
183 }
184}
185```
186β
187<a id="parameters-summary"></a>
188β
189## Parameters
190β
191### options
192β
193`Omit`\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
194β
195The mutation options to use, identical to what you'd pass to `injectMutation`, without a
196`mutationKey`.
197β
198<a id="options-properties"></a>
199β
200#### `options` properties
201β
202Built from [`CreateMutationOptions`](../interfaces/CreateMutationOptions.md#properties). See the type above for what it changes.
203β
204<a id="returns-summary"></a>
205β
206## Returns
207β
208`Omit`\<[`CreateMutationOptions`](../interfaces/CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\>
209β
210The same options object, unchanged.
211β
212<a id="result-properties"></a>
213β
214### Result properties
215β
216Built from [`CreateMutationOptions`](../interfaces/CreateMutationOptions.md#properties). See the type above for what it changes.