Interface YatlCommitRecord<T>

A commit record describing the changes to a single row.

interface YatlCommitRecord<T extends object = UnspecifiedRecord> {
    changedFields: NestedKeyOf<T>[];
    changes: Partial<T>;
    mergedRow: T;
    originalRow: T;
    rowId: RowId;
}

Type Parameters

T extends object = UnspecifiedRecord

Index

Properties

changedFields changes mergedRow originalRow rowId

Properties

changedFields

changedFields: NestedKeyOf<T>[]

List of fields that changed during this transactions

changes

changes: Partial<T>

A partial object of only the fields that changed and their new, parsed values.

mergedRow

mergedRow: T

A new row object containing the originalRow with the 'changes' deeply applied.

originalRow

originalRow: T

A read-only reference to the original, unedited row data.

rowId

rowId: RowId

The unique identifier for the row