Skip to content

Vizel API / core/src / VizelCollaborationState

Interface: VizelCollaborationState ​

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

Collaboration connection state

Properties ​

error ​

ts
error: Error | null;

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

Last error that occurred


isConnected ​

ts
isConnected: boolean;

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

Whether connected to the collaboration server


isSynced ​

ts
isSynced: boolean;

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

Whether the initial document sync is complete


peerCount ​

ts
peerCount: number;

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

Number of currently connected peers (including self)

Released under the MIT License.