Function: createRoom()
@roomful/core / createRoom
Function: createRoom()
Section titled “Function: createRoom()”createRoom<
TPresence>(roomId,options?):Room<TPresence>
Defined in: packages/core/src/room.ts:3128
Creates a realtime room instance.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The custom peer presence shape inferred from options.presence.
Parameters
Section titled “Parameters”roomId
Section titled “roomId”string
The room identifier to join or create.
options?
Section titled “options?”RoomOptions<TPresence> = {}
Optional room configuration.
Returns
Section titled “Returns”Room<TPresence>
The created room instance.