File size: 1,146 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
---
id: injectMutation
title: injectMutation
---
# Function: injectMutation()
```ts
function injectMutation<TData, TError, TVariables, TContext>(
injectMutationFn,
options?,
): CreateMutationResult<TData, TError, TVariables, TContext>
```
Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
Unlike queries, mutations are not run automatically.
## Type Parameters
• **TData** = `unknown`
• **TError** = `Error`
• **TVariables** = `void`
• **TContext** = `unknown`
## Parameters
### injectMutationFn
() => [`CreateMutationOptions`](../../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
A function that returns mutation options.
### options?
[`InjectMutationOptions`](../../interfaces/injectmutationoptions.md)
Additional configuration
## Returns
[`CreateMutationResult`](../../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
The mutation.
## Defined in
[inject-mutation.ts:42](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L42)
|