Interface: RoomfulPluginOptions\<TPresence\>

@roomful/vue

---

@roomful/vue / RoomfulPluginOptions

Interface: RoomfulPluginOptions<TPresence>

Defined in: vue/src/index.ts:74

Configures the Vue plugin.

Extends

• RoomOptions<TPresence>

Type Parameters

TPresence

TPresence extends PresenceData = PresenceData

The room presence shape inferred from presence.

Properties

debug?

optional debug: boolean | DebugOptions

Defined in: core/dist/types.d.ts:451

Enables broad debug logging or fine-grained debug flags.

Inherited from

RoomOptions.debug

---

encryption?

optional encryption: EncryptionOptions

Defined in: core/dist/types.d.ts:447

Enables payload encryption.

Inherited from

RoomOptions.encryption

---

ephemeral?

optional ephemeral: number | boolean

Defined in: core/dist/types.d.ts:456

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.

Inherited from

RoomOptions.ephemeral

---

maxPeers?

optional maxPeers: number

Defined in: core/dist/types.d.ts:419

Caps the number of peers allowed in the room.

Inherited from

RoomOptions.maxPeers

---

onConnect()?

optional onConnect: () => void

Defined in: vue/src/index.ts:85

Runs after the room connects.

Returns

void

---

onDisconnect()?

optional onDisconnect: (payload) => void

Defined in: vue/src/index.ts:90

Runs after the room disconnects.

Parameters

payload

reason?

string

Returns

void

---

onError()?

optional onError: (error) => void

Defined in: vue/src/index.ts:95

Runs when the room emits an operational error.

Parameters

error

RoomfulError

Returns

void

---

presence?

optional presence: Partial<TPresence>

Defined in: core/dist/types.d.ts:415

Seeds the initial local presence payload.

Inherited from

RoomOptions.presence

---

reconnect?

optional reconnect: boolean | ReconnectOptions

Defined in: core/dist/types.d.ts:435

Enables reconnect behavior or custom reconnect timing.

Inherited from

RoomOptions.reconnect

---

relayAuth?

optional relayAuth: RelayAuthToken

Defined in: core/dist/types.d.ts:431

Supplies relay authentication as a token or async token factory.

Inherited from

RoomOptions.relayAuth

---

relayUrl?

optional relayUrl: string

Defined in: core/dist/types.d.ts:427

Overrides the relay URL used for signaling and fallback transports.

Inherited from

RoomOptions.relayUrl

---

roomId

roomId: string

Defined in: vue/src/index.ts:80

Identifies the room to create or join.

---

stunUrls?

optional stunUrls: string[]

Defined in: core/dist/types.d.ts:423

Supplies custom STUN server URLs for WebRTC sessions.

Inherited from

RoomOptions.stunUrls

---

transport?

optional transport: TransportMode

Defined in: core/dist/types.d.ts:411

Selects the preferred transport strategy.

Inherited from

RoomOptions.transport

---

webrtc?

optional webrtc: WebRTCOptions

Defined in: core/dist/types.d.ts:439

Configures WebRTC-specific behavior.

Inherited from

RoomOptions.webrtc

---

websocket?

optional websocket: WebSocketOptions

Defined in: core/dist/types.d.ts:443

Configures WebSocket-specific behavior.

Inherited from

RoomOptions.websocket