API REFERENCE

ApplyRowTransactionResult

Fields, allowed values, and APIs that use ApplyRowTransactionResult.

Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

typescript

export interface ApplyRowTransactionResult<TRow = Record<string, unknown>> {
  rows: TRow[];
  added: ReadonlyArray<{ row: TRow; index: number }>;
  updated: ReadonlyArray<{ row: TRow; previous: TRow; index: number }>;
  removed: ReadonlyArray<{ row: TRow; index: number }>;
  rejected: ReadonlyArray<{ kind: 'add' | 'update' | 'remove'; row: unknown; reason: string }>;
  meta: { txId: number; timestamp: number };
}

APIs using this type

applyTransaction
Adds, updates, and removes source rows by stable ID. Inspect results separately from app server saving.