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

Interface: DevtoolsRoomSnapshot

@roomful/devtools


@roomful/devtools / DevtoolsRoomSnapshot

Defined in: types.ts:269

Represents the full room snapshot shown in devtools.

bridgeVersion: number

Defined in: types.ts:273

Stores the devtools bridge protocol version.


errors: string[]

Defined in: types.ts:278

Stores recent room errors.


events: DevtoolsEventLogEntry[]

Defined in: types.ts:283

Stores recent custom event log entries.


hasSimulatedPeer: boolean

Defined in: types.ts:228

Indicates whether the room currently has a simulated peer.

DevtoolsRoomSummary.hasSimulatedPeer


hasState: boolean

Defined in: types.ts:233

Indicates whether the room has shared state configured.

DevtoolsRoomSummary.hasState


instanceId: string

Defined in: types.ts:238

Identifies the room instance registration.

DevtoolsRoomSummary.instanceId


peerCount: number

Defined in: types.ts:243

Counts currently known peers.

DevtoolsRoomSummary.peerCount


peerId: string

Defined in: types.ts:248

Identifies the local peer.

DevtoolsRoomSummary.peerId


peers: DevtoolsPeerSnapshot[]

Defined in: types.ts:288

Stores peer snapshots.


roomId: string

Defined in: types.ts:253

Identifies the room.

DevtoolsRoomSummary.roomId


state: DevtoolsStateSnapshot

Defined in: types.ts:293

Stores the shared-state snapshot.


status: DevtoolsRoomStatus

Defined in: types.ts:258

Stores the current room connection status.

DevtoolsRoomSummary.status


transport: DevtoolsTransportKind

Defined in: types.ts:263

Stores the active transport.

DevtoolsRoomSummary.transport