--- id: mutationOptions title: mutationOptions --- ## Call Signature ```ts function mutationOptions(options): WithRequired, "mutationKey">; ``` Defined in: [packages/preact-query/src/mutationOptions.ts:34](https://github.com/TanStack/query/blob/main/packages/preact-query/src/mutationOptions.ts#L34) 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`. ### Type Parameters #### TData `TData` = `unknown` #### TError `TError` = `Error` #### TVariables `TVariables` = `void` #### TOnMutateResult `TOnMutateResult` = `unknown` ### Parameters #### options [`WithRequired`](../type-aliases/WithRequired.md)\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> The mutation options to use, identical to what you'd pass to `useMutation`, with a required `mutationKey`. ### Returns [`WithRequired`](../type-aliases/WithRequired.md)\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> The same options object, unchanged. ### See [useMutation](useMutation.md) to run the mutation these options describe. ### Example Looking the mutation up elsewhere via its `mutationKey`, e.g. for a global "saving…" indicator: ```tsx import { mutationOptions, useMutationState } from '@tanstack/preact-query' const createPostOptions = mutationOptions({ mutationKey: ['posts', 'create'], mutationFn: createPost, }) function SavingIndicator() { const isCreatingPost = useMutationState({ filters: { mutationKey: createPostOptions.mutationKey, status: 'pending' }, }).length > 0 return isCreatingPost ? Saving… : null } ``` ## Call Signature ```ts function mutationOptions(options): Omit, "mutationKey">; ``` Defined in: [packages/preact-query/src/mutationOptions.ts:74](https://github.com/TanStack/query/blob/main/packages/preact-query/src/mutationOptions.ts#L74) 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`. ### Type Parameters #### TData `TData` = `unknown` #### TError `TError` = `Error` #### TVariables `TVariables` = `void` #### TOnMutateResult `TOnMutateResult` = `unknown` ### Parameters #### options `Omit`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> The mutation options to use, identical to what you'd pass to `useMutation`, without a `mutationKey`. ### Returns `Omit`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> The same options object, unchanged. ### See [useMutation](useMutation.md) to run the mutation these options describe. ### Remarks See the other overload's example for looking a mutation up via `useMutationState`. ### Example ```tsx import { mutationOptions, useMutation } from '@tanstack/preact-query' export const createPostOptions = mutationOptions({ mutationFn: createPost, }) function CreatePost() { const mutation = useMutation(createPostOptions) return } ```