Type Alias: Peer\<TPresence\>
@roomful/core / Peer
Type Alias: Peer<TPresence>
Section titled “Type Alias: Peer<TPresence>”Peer<
TPresence> =object&Partial<TPresence>
Defined in: packages/core/src/types.ts:482
Describes a local or remote peer known to a room.
Type Declaration
Section titled “Type Declaration”avatar?
Section titled “avatar?”
optionalavatar:string
Exposes the peer avatar URL when available.
color?
Section titled “color?”
optionalcolor:string
Exposes the peer color when available.
id:
string
Identifies the peer across transports.
joinedAt
Section titled “joinedAt”joinedAt:
number
Records when the peer joined the room.
lastSeen
Section titled “lastSeen”lastSeen:
number
Records the last time the peer was observed.
optionalname:string
Exposes a human-readable peer name when available.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The custom presence shape merged into the peer record.