Skip to content

PendingMutation.md

Latest commit

 

History

History
157 lines (94 loc) · 2.98 KB

PendingMutation.md

File metadata and controls

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

Interface: PendingMutation<T, TOperation, TCollection>

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

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

collection

collection: TCollection;

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

createdAt

createdAt: Date;

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

globalKey

globalKey: string;

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

key

key: any;

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

metadata

metadata: unknown;

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

modified

modified: T;

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

mutationId

mutationId: string;

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

optimistic

optimistic: boolean;

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

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

original

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

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

syncMetadata

syncMetadata: Record<string, unknown>;

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

type

type: TOperation;

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

updatedAt

updatedAt: Date;

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