Interface: RoomfulYjsProvider
@roomful/core / RoomfulYjsProvider
Interface: RoomfulYjsProvider
Section titled “Interface: RoomfulYjsProvider”Defined in: packages/core/src/types.ts:653
Exposes the Yjs document and provider used by CRDT state synchronization.
Properties
Section titled “Properties”awareness
Section titled “awareness”
readonlyawareness:Awareness
Defined in: packages/core/src/types.ts:662
Exposes the Yjs awareness instance.
readonlydoc:Doc
Defined in: packages/core/src/types.ts:657
Exposes the shared Yjs document.
status
Section titled “status”
readonlystatus:RoomfulYjsProviderStatus
Defined in: packages/core/src/types.ts:672
Reports the provider connection status.
synced
Section titled “synced”
readonlysynced:boolean
Defined in: packages/core/src/types.ts:667
Indicates whether the provider has completed an initial sync.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect():
Promise<void>
Defined in: packages/core/src/types.ts:679
Opens the provider connection.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when the provider has started connecting.
destroy()
Section titled “destroy()”destroy():
Promise<void>
Defined in: packages/core/src/types.ts:693
Destroys the provider and releases resources.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when teardown finishes.
disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: packages/core/src/types.ts:686
Closes the provider connection.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when disconnect teardown finishes.
off<
TEvent>(event,cb):void
Defined in: packages/core/src/types.ts:716
Removes a provider lifecycle listener.
Type Parameters
Section titled “Type Parameters”TEvent
Section titled “TEvent”TEvent extends keyof RoomfulYjsProviderEventMap
The provider event name being removed.
Parameters
Section titled “Parameters”TEvent
The provider event name to unsubscribe from.
RoomfulYjsProviderEventHandler<TEvent>
The callback to remove.
Returns
Section titled “Returns”void
Nothing.
on<
TEvent>(event,cb):Unsubscribe
Defined in: packages/core/src/types.ts:703
Subscribes to provider lifecycle events.
Type Parameters
Section titled “Type Parameters”TEvent
Section titled “TEvent”TEvent extends keyof RoomfulYjsProviderEventMap
The provider event name to subscribe to.
Parameters
Section titled “Parameters”TEvent
The provider event name to observe.
RoomfulYjsProviderEventHandler<TEvent>
The callback invoked with the matching payload.
Returns
Section titled “Returns”A function that removes the listener.