Vizel API / core/src / VizelYjsAwareness

Interface: VizelYjsAwareness

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

Interface matching the Yjs Awareness API. Compatible with y-protocols/awareness Awareness class.

Methods

getStates()

getStates(): Map<number, Record<string, unknown>>;

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

Get all awareness states from connected peers

Returns

Map<number, Record<string, unknown>>

---

off()

off(event, handler): void;

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

Unsubscribe from awareness events

Parameters

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

Returns

void

---

on()

on(event, handler): void;

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

Subscribe to awareness events

Parameters

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

Returns

void

---

setLocalStateField()

setLocalStateField(field, value): void;

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

Set a field on the local awareness state

Parameters

Parameter	Type
field	string
value	unknown

Returns

void