CreateOptimisticActionsOptions.md

id	CreateOptimisticActionsOptions
title	CreateOptimisticActionsOptions

Interface: CreateOptimisticActionsOptions<TVars, T>

Defined in: packages/db/src/types.ts:128

Options for the createOptimisticAction helper

Extends

• Omit<TransactionConfig<T>, "mutationFn">

Type Parameters

TVars

TVars = unknown

T

T extends object = Record<string, unknown>

Properties

autoCommit?

optional autoCommit: boolean;

Defined in: packages/db/src/types.ts:119

Inherited from

TransactionConfig.autoCommit

---

id?

optional id: string;

Defined in: packages/db/src/types.ts:117

Unique identifier for the transaction

Inherited from

Omit.id

---

metadata?

optional metadata: Record<string, unknown>;

Defined in: packages/db/src/types.ts:122

Custom metadata to associate with the transaction

Inherited from

Omit.metadata

---

mutationFn()

mutationFn: (vars, params) => Promise<any>;

Defined in: packages/db/src/types.ts:135

Function to execute the mutation on the server

Parameters

vars

TVars

params

MutationFnParams<T>

Returns

Promise<any>

---

onMutate()

onMutate: (vars) => void;

Defined in: packages/db/src/types.ts:133

Function to apply optimistic updates locally before the mutation completes

Parameters

vars

TVars

Returns

void