Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

mutationOptions.md

193 lines6.4 KB

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
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>
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.