ws-asyncapi API / cursors / cursorsStore

Function: cursorsStore()

cursorsStore<S>(client, options?): Subscribable<Map<string, CursorPoint>>

Defined in: .api-entries/cursors/index.d.ts:69

Live cursors as a Subscribable: a Map<socketId, {x,y}> of other members' (optionally smoothed) cursor positions, derived from presence diffs. Self is excluded; members that leave (or clear their cursor) are dropped. Bind it with the framework's generic store hook (useStore / fromStore).

Type Parameters

S

S = { cursor?: CursorPoint; }

Parameters

client

CursorsClient<S>

options?

CursorsOptions<S>

Returns

Subscribable<Map<string, CursorPoint>>