TLSyncStorageTransactionResult

Result returned from a storage transaction.

interface TLSyncStorageTransactionResult<
  T,
  R extends UnknownRecord = UnknownRecord,
> {}

Properties

The actual changes that occurred during the transaction, if requested via emitChanges option. This is a RecordsDiff where: - added contains records that were put (we don't have "from" state for emitted changes) - removed contains records that were deleted (with placeholder values since we only have IDs) - updated is empty (emitted changes don't track before/after pairs)

Only populated when: - emitChanges: 'always' was specified, or - emitChanges: 'when-different' was specified and the storage layer modified records

changes?: TLSyncForwardDiff<R>;

didChange: boolean;

documentClock: number;

result: T;