Y

Override:

The AbstractConnector.that is used by this Yjs instance.

The AbstractPersistence that is used by this Yjs instance.

The room name that this Yjs instance connects to.

Define a shared data type.

Multiple calls of y.define(name, TypeConstructor) yield the same result and do not overwrite each other. I.e. y.define(name, type) === y.define(name, type)

After this method is called, the type is also available on y.share[name].

Best Practices: Either define all types right after the Yjs instance is created or always use y.define(..) when accessing a type.

Example:

  // Option 1
  const y = new Y(..)
  y.define('myArray', YArray)
  y.define('myMap', YMap)
  // .. when accessing the type use y.share[name]
  y.share.myArray.insert(..)
  y.share.myMap.set(..)

  // Option2
  const y = new Y(..)
  // .. when accessing the type use `y.define(..)`
  y.define('myArray', YArray).insert(..)
  y.define('myMap', YMap).set(..)

Disconnect from the room, and destroy all traces of this Yjs instance. Persisted data will remain until removed by the persistence adapter.

Override:

Disconnect this Yjs Instance from the network. The connector will unsubscribe from the room and document updates are not shared anymore.

Get a defined type. The type must be defined locally. First define the type with define.

This returns the same value as y.share[name]

If disconnected, tell the connector to reconnect to the room.

Changes that happen inside of a transaction are bundled. This means that the observer fires after the transaction is finished and that all changes that happened inside of the transaction are sent as one message to the other peers.