Skip to main content
GitHub

Source

useSequentialRoomConnectDisconnect

When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap.

Import

import { useSequentialRoomConnectDisconnect } from "@livekit/components-react";

Usage

const { connect, disconnect } = useSequentialRoomConnectDisconnect(room);
// Connecting to a room:
useEffect(() => {
connect();
return () => disconnect();
}, [connect, disconnect]);

Properties

roomRRequired

Returns

UseSequentialRoomConnectDisconnectResults<R>;