Vizel API / svelte/src / CreateVizelCollaborationResult

Interface: CreateVizelCollaborationResult

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:13

Collaboration rune result

Properties

connect

connect: () => void;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:23

Connect to the collaboration server

Returns

void

---

disconnect

disconnect: () => void;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:25

Disconnect from the collaboration server

Returns

void

---

error

readonly error: Error | null;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:21

Last error that occurred

---

isConnected

readonly isConnected: boolean;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:15

Whether connected to the collaboration server

---

isSynced

readonly isSynced: boolean;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:17

Whether the initial document sync is complete

---

peerCount

readonly peerCount: number;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:19

Number of currently connected peers (including self)

---

updateUser

updateUser: (user) => void;

Defined in: packages/svelte/src/runes/createVizelCollaboration.svelte.ts:27

Update the current user's cursor information

Parameters

Parameter	Type
user	VizelCollaborationUser

Returns

void