Skip to content
Roomful

Interface: RoomOptions\<TPresence\>

@roomful/core

@roomful/core / RoomOptions

Interface: RoomOptions<TPresence>

Section titled “Interface: RoomOptions<TPresence>”

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

Configures room creation.

Type Parameters

Section titled “Type Parameters”

TPresence

Section titled “TPresence”

TPresence extends PresenceData = PresenceData

The local and remote presence shape carried by the room.

Properties

Section titled “Properties”

debug?

Section titled “debug?”

optional debug: boolean | DebugOptions

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

Enables broad debug logging or fine-grained debug flags.

encryption?

Section titled “encryption?”

optional encryption: EncryptionOptions

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

Enables payload encryption.

ephemeral?

Section titled “ephemeral?”

optional ephemeral: number | boolean

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

Marks the room as ephemeral — no durable storage (state, comments, locks), and optionally disconnects after ttlMs. Pass true for no-persistence only, or a number for TTL in ms.

maxPeers?

Section titled “maxPeers?”

optional maxPeers: number

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

Caps the number of peers allowed in the room.

presence?

Section titled “presence?”

optional presence: Partial<TPresence>

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

Seeds the initial local presence payload.

reconnect?

Section titled “reconnect?”

optional reconnect: boolean | ReconnectOptions

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

Enables reconnect behavior or custom reconnect timing.

relayAuth?

Section titled “relayAuth?”

optional relayAuth: RelayAuthToken

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

Supplies relay authentication as a token or async token factory.

relayUrl?

Section titled “relayUrl?”

optional relayUrl: string

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

Overrides the relay URL used for signaling and fallback transports.

stunUrls?

Section titled “stunUrls?”

optional stunUrls: string[]

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

Supplies custom STUN server URLs for WebRTC sessions.

transport?

Section titled “transport?”

optional transport: TransportMode

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

Selects the preferred transport strategy.

webrtc?

Section titled “webrtc?”

optional webrtc: WebRTCOptions

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

Configures WebRTC-specific behavior.

websocket?

Section titled “websocket?”

optional websocket: WebSocketOptions

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

Configures WebSocket-specific behavior.