Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

PendingMutation.md

157 lines3.0 KB

Interface: PendingMutation<T, TOperation, TCollection>

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

Represents a pending mutation within a transaction Contains information about the original and modified data, as well as metadata

Type Parameters

T

T extends object = Record<string, unknown>

TOperation

TOperation extends OperationType = OperationType

TCollection

TCollection extends Collection<T, any, any, any, any> = Collection<T, any, any, any, any>

Properties

changes

changes: ResolveTransactionChanges<T, TOperation>;

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


collection

collection: TCollection;

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


createdAt

createdAt: Date;

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


globalKey

globalKey: string;

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


key

key: any;

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


metadata

metadata: unknown;

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


modified

modified: T;

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


mutationId

mutationId: string;

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


optimistic

optimistic: boolean;

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

Whether this mutation should be applied optimistically (defaults to true)


original

original: TOperation extends "insert" ? object : T;

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


syncMetadata

syncMetadata: Record<string, unknown>;

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


type

type: TOperation;

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


updatedAt

updatedAt: Date;

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