File size: 1,441 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 53 54 55 56 57 58 59 60 61 |
import type {
DefaultError,
MutationObserverOptions,
OmitKeyof,
} from '@tanstack/query-core'
/**
* Allows to share and re-use mutation options in a type-safe way.
*
* **Example**
*
* ```ts
* export class QueriesService {
* private http = inject(HttpClient);
*
* updatePost(id: number) {
* return mutationOptions({
* mutationFn: (post: Post) => Promise.resolve(post),
* mutationKey: ["updatePost", id],
* onSuccess: (newPost) => {
* // ^? newPost: Post
* this.queryClient.setQueryData(["posts", id], newPost);
* },
* });
* }
* }
*
* queries = inject(QueriesService)
* idSignal = new Signal(0);
* mutation = injectMutation(() => this.queries.updatePost(this.idSignal()))
*
* mutation.mutate({ title: 'New Title' })
* ```
* @param options - The mutation options.
* @returns Mutation options.
* @public
*/
export function mutationOptions<
TData = unknown,
TError = DefaultError,
TVariables = void,
TContext = unknown,
>(
options: MutationObserverOptions<TData, TError, TVariables, TContext>,
): CreateMutationOptions<TData, TError, TVariables, TContext> {
return options
}
/**
* @public
*/
export interface CreateMutationOptions<
TData = unknown,
TError = DefaultError,
TVariables = void,
TContext = unknown,
> extends OmitKeyof<
MutationObserverOptions<TData, TError, TVariables, TContext>,
'_defaulted'
> {}
|