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

Interface: AwarenessState

@roomful/core

@roomful/core / AwarenessState

Interface: AwarenessState

Section titled “Interface: AwarenessState”

Defined in: packages/core/src/types.ts:951

Describes awareness metadata shared by a peer.

Indexable

Section titled “Indexable”

[key: string]: unknown

Carries additional awareness metadata.

Properties

Section titled “Properties”

focus?

Section titled “focus?”

optional focus: string | null

Defined in: packages/core/src/types.ts:965

Identifies the focused element when available.

peerId

Section titled “peerId”

peerId: string

Defined in: packages/core/src/types.ts:955

Identifies the peer that owns this awareness state.

selection?

Section titled “selection?”

optional selection: AwarenessSelection | null

Defined in: packages/core/src/types.ts:970

Supplies the peer selection when available.

typing?

Section titled “typing?”

optional typing: boolean

Defined in: packages/core/src/types.ts:960

Indicates whether the peer is typing.