Skip to content
Roomful is in public beta — install with the @beta tag. Share feedback →

Function: usePeers()

@roomful/react


@roomful/react / usePeers

usePeers<TPresence>(): Peer<TPresence>[]

Defined in: react/src/index.ts:570

Subscribes to the full peer list for the current room.

TPresence extends PresenceData = PresenceData

The room presence shape.

Peer<TPresence>[]

The latest peer list.