Function: provideRoomful()
@roomful/angular / provideRoomful
Function: provideRoomful()
Section titled “Function: provideRoomful()”provideRoomful<
TPresence>(roomId,options?):EnvironmentProviders
Defined in: angular/src/index.ts:677
Creates a room and provides it to the Angular injector.
The returned providers create the room, connect it, forward connected,
disconnected, and error events to the optional callbacks, and disconnect
the room when the surrounding injection context is destroyed.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape inferred from options.presence.
Parameters
Section titled “Parameters”roomId
Section titled “roomId”string
Identifies the room to create or join.
options?
Section titled “options?”RoomfulProviderOptions<TPresence> = {}
The room configuration and lifecycle callbacks.
Returns
Section titled “Returns”EnvironmentProviders
Environment providers exposing the room through ROOMFUL_ROOM.