TinyBase logoTinyBase

YjsPersister

The YjsPersister interface represents a Persister that lets you save and load Store data to and from a Yjs document.

You should use the createYjsPersister function to create a YjsPersister object.

It is a minor extension to the Persister interface and simply provides an extra getYDoc method for accessing the Yjs document the Store is being persisted to.

Since

v4.3.14

Getter methods

This is the collection of getter methods within the YjsPersister interface. There are only two getter methods, getStore and getYDoc.

Listener methods

This is the collection of listener methods within the YjsPersister interface. There are only two listener methods, addStatusListener and delListener.

Lifecycle methods

This is the collection of lifecycle methods within the YjsPersister interface. There are only three lifecycle methods, destroy, getStatus, and schedule.

Load methods

This is the collection of load methods within the YjsPersister interface. There are 4 load methods in total.

Save methods

This is the collection of save methods within the YjsPersister interface. There are 4 save methods in total.

Development methods

This is the collection of development methods within the YjsPersister interface. There is only one method, getStats.