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

injectmutation.md

47 lines998 Bytes

1---
2id: injectMutation
3title: injectMutation
4---
5​
6# Function: injectMutation()
7​
8```ts
9function injectMutation<TData, TError, TVariables, TContext>(
10 optionsFn,
11 injector?,
12): CreateMutationResult<TData, TError, TVariables, TContext>
13```
14​
15Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
16​
17Unlike queries, mutations are not run automatically.
18​
19## Type Parameters
20​
21β€’ **TData** = `unknown`
22​
23β€’ **TError** = `Error`
24​
25β€’ **TVariables** = `void`
26​
27β€’ **TContext** = `unknown`
28​
29## Parameters
30​
31β€’ **optionsFn**
32​
33A function that returns mutation options.
34​
35β€’ **injector?**: `Injector`
36​
37The Angular injector to use.
38​
39## Returns
40​
41[`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
42​
43The mutation.
44​
45## Defined in
46​
47[inject-mutation.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation.ts#L38)