Open History to see the last commit
1import type {
2 DefaultError,
3 MutationObserverOptions,
4 OmitKeyof,
5} from '@tanstack/query-core'
6β
7/**
8 * Allows to share and re-use mutation options in a type-safe way.
9 *
10 * **Example**
11 *
12 * ```ts
13 * export class QueriesService {
14 * private http = inject(HttpClient);
15 *
16 * updatePost(id: number) {
17 * return mutationOptions({
18 * mutationFn: (post: Post) => Promise.resolve(post),
19 * mutationKey: ["updatePost", id],
20 * onSuccess: (newPost) => {
21 * // ^? newPost: Post
22 * this.queryClient.setQueryData(["posts", id], newPost);
23 * },
24 * });
25 * }
26 * }
27 *
28 * queries = inject(QueriesService)
29 * idSignal = new Signal(0);
30 * mutation = injectMutation(() => this.queries.updatePost(this.idSignal()))
31 *
32 * mutation.mutate({ title: 'New Title' })
33 * ```
34 * @param options - The mutation options.
35 * @returns Mutation options.
36 * @public
37 */
38export function mutationOptions<
39 TData = unknown,
40 TError = DefaultError,
41 TVariables = void,
42 TContext = unknown,
43>(
44 options: MutationObserverOptions<TData, TError, TVariables, TContext>,
45): CreateMutationOptions<TData, TError, TVariables, TContext> {
46 return options
47}
48β
49/**
50 * @public
51 */
52export interface CreateMutationOptions<
53 TData = unknown,
54 TError = DefaultError,
55 TVariables = void,
56 TContext = unknown,
57> extends OmitKeyof<
58 MutationObserverOptions<TData, TError, TVariables, TContext>,
59 '_defaulted'
60 > {}