Skip to main content
Version: 57.2.0

setRealtimeSocket

setRealtimeSocket(socket): void

Provide the Socket.io client instance used by realtimeDocument and realtimeList.

Call this once after your socket connects (e.g. inside useSocketConnection's onConnect callback, or in a useEffect that watches the socket ref).

Parameters​

socket​

Socket<DefaultEventsMap, DefaultEventsMap> | null

Returns​

void

Example​

const { socket } = useSocketConnection({ ... });

useEffect(() => {
  setRealtimeSocket(socket);
  return () => setRealtimeSocket(null);
}, [socket]);