Function: useRoom()
@roomful/solid / useRoom
Function: useRoom()
Section titled “Function: useRoom()”useRoom<
TPresence>():Room<TPresence>
Defined in: solid/src/index.ts:730
Returns the current room from RoomfulProvider.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape to project onto the room.
Returns
Section titled “Returns”Room<TPresence>
The current room instance.
Throws
Section titled “Throws”When called outside RoomfulProvider.