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

mutationOptions.md

57 lines1.1 KB

1---
2id: mutationOptions
3title: mutationOptions
4---
5​
6# Function: mutationOptions()
7​
8```ts
9function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options): MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
10```
11​
12Defined in: [packages/lit-query/src/mutationOptions.ts:22](https://github.com/TanStack/query/blob/main/packages/lit-query/src/mutationOptions.ts#L22)
13​
14Preserves and types mutation options for reuse across Lit Query APIs.
15​
16## Type Parameters
17​
18### TData
19​
20`TData` = `unknown`
21​
22### TError
23​
24`TError` = `Error`
25​
26### TVariables
27​
28`TVariables` = `void`
29​
30### TOnMutateResult
31​
32`TOnMutateResult` = `unknown`
33​
34## Parameters
35​
36### options
37​
38`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
39​
40Mutation options to preserve.
41​
42## Returns
43​
44`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
45​
46The same options object.
47​
48## Example
49​
50```ts
51import { mutationOptions } from '@tanstack/lit-query'
52​
53const addTodoOptions = mutationOptions({
54 mutationKey: ['add-todo'],
55 mutationFn: (title: string) => addTodo(title),
56})
57```