TLSyncStorageTransactionOptions

See source code
Table of contents

Options for a transaction.

interface TLSyncStorageTransactionOptions {}

Properties

emitChanges

optional

Controls when the storage layer should emit the actual changes that occurred during the transaction.

  • 'always' - Always emit the changes, regardless of whether they were applied verbatim - 'when-different' - Only emit changes if the storage layer modified/embellished the records (e.g., added server timestamps, normalized data, etc.)

When changes are emitted, they will be available in the changes field of the transaction result. This is useful when the storage layer may transform records and the caller needs to know what actually changed rather than what was requested.

emitChanges?: 'always' | 'when-different'

id

optional

Use this if you need to identify the transaction for logging or debugging purposes or for ignoring certain changes in onChange callbacks

id?: string

Prev
TLSyncStorageTransaction
Next
TLSyncStorageTransactionResult