import { useContext } from "react";

import { RefineContext } from "@contexts/refine";
import { IRefineContext } from "../../interfaces";

type UseMutationModeType = () => {
    mutationMode: IRefineContext["mutationMode"];
    undoableTimeout: IRefineContext["undoableTimeout"];
};

/**
 * Mutation mode determines which mode the mutation runs with.
 * Mutations can run under three different modes: `pessimistic`, `optimistic` and `undoable`.
 * Each mode corresponds to a different type of user experience.
 *
 * @see {@link https://refine.dev/docs/guides-and-concepts/mutation-mode} for more details.
 */
export const useMutationMode: UseMutationModeType = () => {
    const { mutationMode, undoableTimeout } = useContext(RefineContext);

    return { mutationMode, undoableTimeout };
};