Vizel API / core/src / VizelYjsProvider

Interface: VizelYjsProvider

Defined in: packages/core/src/collaboration.ts:44

Interface matching Yjs WebSocket provider API. Compatible with y-websocket WebsocketProvider and similar providers that emit "status" and "sync" events.

Properties

awareness

awareness: VizelYjsAwareness;

Defined in: packages/core/src/collaboration.ts:46

Awareness instance for cursor/presence tracking

Methods

connect()

connect(): void;

Defined in: packages/core/src/collaboration.ts:48

Connect to the collaboration server

Returns

void

---

destroy()

destroy(): void;

Defined in: packages/core/src/collaboration.ts:52

Destroy the provider and release resources

Returns

void

---

disconnect()

disconnect(): void;

Defined in: packages/core/src/collaboration.ts:50

Disconnect from the collaboration server

Returns

void

---

off()

off(event, handler): void;

Defined in: packages/core/src/collaboration.ts:56

Unsubscribe from provider events

Parameters

Parameter	Type
event	string
handler	(...args) => void

Returns

void

---

on()

on(event, handler): void;

Defined in: packages/core/src/collaboration.ts:54

Subscribe to provider events

Parameters

Parameter	Type
event	string
handler	(...args) => void

Returns

void