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