API Documentation / @pinia/colada / useMutationCache

Variable: useMutationCache

const useMutationCache: StoreDefinition<"_pc_mutation", Pick<{
  caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>;
  create: <TData, TVars, TError, TContext>(options, key?, vars?) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensure: <TData, TVars, TError, TContext>(entry, vars) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensureDefinedMutation: <T>(fn) => unknown;
  extend: <TData, TVars, TError, TContext>(_entry) => void;
  get: <TData, TVars, TError, TContext>(key) => 
     | UseMutationEntry<TData, TVars, TError, TContext>
    | undefined;
  getEntries: (filters) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[];
  mutate: <TData, TVars, TError, TContext>(entry) => Promise<TData>;
  remove: <TData, TVars, TError, TContext>(entry) => void;
  setEntryState: <TData, TVars, TError, TContext>(entry, state) => void;
  untrack: <TData, TVars, TError, TContext>(entry) => void;
}, "caches" | "_s">, Pick<{
  caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>;
  create: <TData, TVars, TError, TContext>(options, key?, vars?) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensure: <TData, TVars, TError, TContext>(entry, vars) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensureDefinedMutation: <T>(fn) => unknown;
  extend: <TData, TVars, TError, TContext>(_entry) => void;
  get: <TData, TVars, TError, TContext>(key) => 
     | UseMutationEntry<TData, TVars, TError, TContext>
    | undefined;
  getEntries: (filters) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[];
  mutate: <TData, TVars, TError, TContext>(entry) => Promise<TData>;
  remove: <TData, TVars, TError, TContext>(entry) => void;
  setEntryState: <TData, TVars, TError, TContext>(entry, state) => void;
  untrack: <TData, TVars, TError, TContext>(entry) => void;
}, never>, Pick<{
  caches: Ref<Map<string, UseMutationEntry<unknown, any, unknown, any>>, Map<string, UseMutationEntry<unknown, any, unknown, any>>>;
  create: <TData, TVars, TError, TContext>(options, key?, vars?) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensure: <TData, TVars, TError, TContext>(entry, vars) => UseMutationEntry<TData, TVars, TError, TContext>;
  ensureDefinedMutation: <T>(fn) => unknown;
  extend: <TData, TVars, TError, TContext>(_entry) => void;
  get: <TData, TVars, TError, TContext>(key) => 
     | UseMutationEntry<TData, TVars, TError, TContext>
    | undefined;
  getEntries: (filters) => UseMutationEntry<unknown, unknown, unknown, _EmptyObject>[];
  mutate: <TData, TVars, TError, TContext>(entry) => Promise<TData>;
  remove: <TData, TVars, TError, TContext>(entry) => void;
  setEntryState: <TData, TVars, TError, TContext>(entry, state) => void;
  untrack: <TData, TVars, TError, TContext>(entry) => void;
}, 
  | "get"
  | "create"
  | "ensure"
  | "ensureDefinedMutation"
  | "mutate"
  | "remove"
  | "extend"
  | "setEntryState"
  | "getEntries"
| "untrack">>;

Composable to get the cache of the mutations. As any other composable, it can be used inside the setup function of a component, within another composable, or in injectable contexts like stores and navigation guards.