API Documentation / @pinia/colada / UseMutationEntryExtensions

Interface: UseMutationEntryExtensions<TData, TVars, TError, TContext>

Allows defining extensions to the mutation entry that are returned by useMutation().

Type Parameters

TData

TData

TVars

TVars

TError

TError

TContext

TContext extends Record<any, any> = _EmptyObject

Properties

dataUpdatedAt?

optional dataUpdatedAt: ShallowRef<number>;

Timestamp of when data was last successfully returned. TanStack Query compatible property.

---

errorUpdatedAt?

optional errorUpdatedAt: ShallowRef<number>;

Timestamp of when an error last occurred. TanStack Query compatible property.

---

isError?

optional isError: ComputedRef<boolean>;

Whether the mutation status is 'error'. TanStack Query compatible property.

---

isIdle?

optional isIdle: ComputedRef<boolean>;

Whether the mutation has never been called (status is 'pending' and asyncStatus is 'idle'). TanStack Query compatible property.

---

isPending?

optional isPending: ComputedRef<boolean>;

Whether the mutation is currently in progress (asyncStatus === 'loading'). TanStack Query compatible property.

---

isSuccess?

optional isSuccess: ComputedRef<boolean>;

Whether the mutation status is 'success'. TanStack Query compatible property.

---

submittedAt?

optional submittedAt: ShallowRef<number>;

Timestamp of when the mutation was last submitted. TanStack Query compatible property.