WebSocketNetworkEventsRecord | @collabs/ws-client

Events record for WebSocketNetwork.

Index

Connect: {}

Emitted when we connect to the server.

Disconnect: { cause: "close" | "error" | "manual"; wsEvent: null | CloseEvent | Event }

Emitted when we disconnect from the server.

This is also emitted if we fail to connect to the server.

cause: "close" | "error" | "manual"
The reason for the disconnection:
- "close": A WebSocket "close" event.
- "error": A WebSocket "error" event.
- "manual": A call to WebSocketNetwork.disconnect or WebSocketNetwork.close.
wsEvent: null | CloseEvent | Event

The WebSocket event, if cause is "close" or "error" (else null).

Load: { doc: AbstractDoc | CRuntime; docID: string }

Emitted after doc loads the server's current state.

This may be emitted multiple times for a doc - in particular, after reconnecting.

Save: { doc: AbstractDoc | CRuntime; docID: string }

Emitted after all of doc's local changes are confirmed saved to the server.

SubscribeDenied: { doc: AbstractDoc | CRuntime; docID: string }

Emitted if we subscribe to a docID but the server denies us access.