Source: https://tanstack.com/db/latest/docs/reference/interfaces/CreateOptimisticActionsOptions

TanStack

DB v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

Guides

• Live Queries
  
  core

• Mutations
  
  core

• Schemas
  
  core

• Error Handling
  
  core

• Creating Collection Options Creators
  
  core

Collections

• Query Collection
  
  core

• Electric Collection
  
  core

• TrailBase Collection
  
  core

• RxDB Collection
  
  core

• PowerSync Collection
  
  core

• LocalStorage Collection
  
  core

• LocalOnly Collection
  
  core

Frameworks

• React
  
  core

• Vue
  
  core

• Angular
  
  core

• Solid
  
  core

• Svelte
  
  core

Community

• Resources & Packages
  
  core

API Reference

• Core API Reference
  
  core

• Collection
  
  core

• createCollection
  
  core

• liveQueryCollectionOptions
  
  core

• createLiveQueryCollection
  
  core

• createOptimisticAction
  
  core

• createTransaction
  
  core

• Electric DB Collection
  
  core

• electricCollectionOptions
  
  core

• Query DB Collection
  
  core

• queryCollectionOptions
  
  core

• RxDB DB Collection
  
  core

• rxdbCollectionOptions
  
  core

• PowerSync Collection
  
  core

• powerSyncCollectionOptions
  
  core

• React Hooks
  
  react

• useLiveQuery
  
  react

Framework

React

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

Guides

• Live Queries
  
  core

• Mutations
  
  core

• Schemas
  
  core

• Error Handling
  
  core

• Creating Collection Options Creators
  
  core

Collections

• Query Collection
  
  core

• Electric Collection
  
  core

• TrailBase Collection
  
  core

• RxDB Collection
  
  core

• PowerSync Collection
  
  core

• LocalStorage Collection
  
  core

• LocalOnly Collection
  
  core

Frameworks

• React
  
  core

• Vue
  
  core

• Angular
  
  core

• Solid
  
  core

• Svelte
  
  core

Community

• Resources & Packages
  
  core

API Reference

• Core API Reference
  
  core

• Collection
  
  core

• createCollection
  
  core

• liveQueryCollectionOptions
  
  core

• createLiveQueryCollection
  
  core

• createOptimisticAction
  
  core

• createTransaction
  
  core

• Electric DB Collection
  
  core

• electricCollectionOptions
  
  core

• Query DB Collection
  
  core

• queryCollectionOptions
  
  core

• RxDB DB Collection
  
  core

• rxdbCollectionOptions
  
  core

• PowerSync Collection
  
  core

• powerSyncCollectionOptions
  
  core

• React Hooks
  
  react

• useLiveQuery
  
  react

On this page

• Interface: CreateOptimisticActionsOptions<TVars, T>

• Extends

• Type Parameters

• TVars

• T

• Properties

• autoCommit?

• Inherited from

• id?

• Inherited from

• metadata?

• Inherited from

• mutationFn()

• Parameters

• vars

• params

• Returns

• onMutate()

• Parameters

• vars

• Returns

CreateOptimisticActionsOptions

Copy Markdown

Interface: CreateOptimisticActionsOptions<TVars, T>
===================================================

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

Options for the createOptimisticAction helper

Extends
-------

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

Type Parameters
--------------- ### TVars

TVars = unknown

### T

T extends object = Record<string, unknown>

Properties
---------- ### autoCommit?

ts

optional autoCommit: boolean;


optional autoCommit: boolean;

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

#### Inherited from

TransactionConfig .autoCommit

---

### id?

ts

optional id: string;


optional id: string;

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

Unique identifier for the transaction

#### Inherited from

ts

Omit.id


Omit.id

---

### metadata?

ts

optional metadata: Record<string, unknown>;


optional metadata: Record<string, unknown>;

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

Custom metadata to associate with the transaction

#### Inherited from

ts

Omit.metadata


Omit.metadata

---

### mutationFn()

ts

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


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

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

Function to execute the mutation on the server

#### Parameters ##### vars

TVars

##### params

MutationFnParams <T>

#### Returns

Promise<any>

---

### onMutate()

ts

onMutate: (vars) => void;


onMutate: (vars) => void;

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

Function to apply optimistic updates locally before the mutation completes

#### Parameters ##### vars

TVars

#### Returns

void

Edit on GitHub

Home

Partners Become a Partner