Skip to content

PendingMutation.md

Latest commit

 

History

History
157 lines (94 loc) · 2.99 KB

PendingMutation.md

File metadata and controls

157 lines (94 loc) · 2.99 KB
id PendingMutation
title PendingMutation

Interface: PendingMutation<T, TOperation, TCollection>

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

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:105

collection

collection: TCollection;

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

createdAt

createdAt: Date;

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

globalKey

globalKey: string;

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

key

key: any;

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

metadata

metadata: unknown;

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

modified

modified: T;

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

mutationId

mutationId: string;

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

optimistic

optimistic: boolean;

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

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

original

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

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

syncMetadata

syncMetadata: Record<string, unknown>;

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

type

type: TOperation;

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

updatedAt

updatedAt: Date;

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