Interface YjsProviderOptions

Options for createYjsProvider.

interface YjsProviderOptions {
    roomPrefix?: string;
    transport?: YjsTransport;
    webrtcOpts?: Record<string, unknown>;
    wsServerUrl?: string;
}

Properties

roomPrefix?: string

Room name prefix. The provider appends /{entityType} to scope each entity-type doc to a distinct room.

"entity-graph"

Transport mode.

"websocket"

webrtcOpts?: Record<string, unknown>

Extra options passed verbatim to the WebrtcProvider constructor. Use to configure signalling servers or encryption.

wsServerUrl?: string

WebSocket server URL (required when transport includes "websocket"). Example: "ws://localhost:1234".