Transaction(y)

A transaction is created for every change on the Yjs model. It is possible to bundle changes on the Yjs model in a single transaction to minimize the number on messages sent and the number of observer calls. If possible the user of this library should bundle as many changes as possible. Here is an example to illustrate the advantages of bundling:

new Transaction(y)
utils/Transaction.js, line 45

Parameters:
Name Type Description
y Y
Example
const map = y.define('map', YMap)
// Log content when change is triggered
map.observe(() => {
  console.log('change triggered')
})
// Each change on the map type triggers a log message:
map.set('a', 0) // => "change triggered"
map.set('b', 0) // => "change triggered"
// When put in a transaction, it will trigger the log after the transaction:
y.transact(() => {
  map.set('a', 1)
  map.set('b', 1)
}) // => "change triggered"

Members

afterState :Map.<Number, Number>
utils/Transaction.js, line 69

Holds the state after the transaction.

beforeState :Map.<Number, Number>
utils/Transaction.js, line 64

Holds the state before the transaction started.

changed :Map.<AbstractType.<YEvent>, Set.<(String|null)>>
utils/Transaction.js, line 76

All types that were directly modified (property added or child inserted/deleted). New types are not included in this Set. Maps from type to parentSubs (item._parentSub = null for YArray)

changedParentTypes :Map.<AbstractType.<YEvent>, Array.<YEvent>>
utils/Transaction.js, line 82

Stores the events for the types that observe also child elements. It is mainly used by observeDeep.

deleteSet :DeleteSet
utils/Transaction.js, line 59

Describes the set of deleted items by ids

updateMessage :encoding.Encoder|null
utils/Transaction.js, line 98

y :Y
utils/Transaction.js, line 54

The Yjs instance.