Vizel API / core/src / VizelPresenceAwareness

Interface: VizelPresenceAwareness

Defined in: packages/core/src/extensions/presence.ts:38

Minimal awareness interface that Vizel's presence extension consumes.

The Yjs Awareness instance satisfies this shape natively. Adapters for other providers (Liveblocks, Convex, custom WebSocket protocols) wrap their native API into this same surface.

Properties

getStates

readonly getStates: () => ReadonlyMap<number, VizelPresenceUserState>;

Defined in: packages/core/src/extensions/presence.ts:40

Snapshot of every connected user's state, keyed by client id.

Returns

ReadonlyMap<number, VizelPresenceUserState>

---

on

readonly on: (event, handler) => () => void;

Defined in: packages/core/src/extensions/presence.ts:46

Subscribe to state-change events. Returns an unsubscribe handle.

Parameters

Parameter	Type
event	"update"
handler	() => void

Returns

() => void

---

setLocalState

readonly setLocalState: (state) => void;

Defined in: packages/core/src/extensions/presence.ts:42

Publish the local user's state.

Parameters

Parameter	Type
state	VizelPresenceUserState

Returns

void