Class RemoteRoom

constructor

• new RemoteRoom(roomId, data?): RemoteRoom

• Create a remote room.

  Parameters

  • roomId: string

  • data: Record<string, unknown> = {}

    The key-value data object to assign to this room.

  Returns RemoteRoom

data

roomId

get

• get<T>(key): T

• Get the data value for the given key.

  Type Parameters

  • T

  Parameters

  • key: string

    An arbitrary bridge-specific key.

  Returns T

  Stored data for this key. May be undefined.

getId

• getId(): string

• Get the room ID.

  Returns string

  The room ID

serialize

• serialize(): Record<string, unknown>

• Serialize all the data about this room, excluding the room ID.

  Returns Record<string, unknown>

  The serialised data

set

• set(key, val): void

• Set an arbitrary bridge-specific data value for this room.

  Parameters

  • key: string

    The key to store the data value under.

  • val: unknown

    The data value. This value should be serializable via JSON.stringify(data).

  Returns void