Reference / @getenginex/sdk-react / useRealtimeStatus
useRealtimeStatus()
useRealtimeStatus():
RealtimeStatus
Status of the client's realtime connection ('connecting', 'open', 'reconnecting', 'closed' or 'unavailable'), reactive. It does not open the connection: it opens with the first useRealtime or useRealtimeSync. On the server and during hydration it is 'closed'.
Returns
The current status.
Throws
If called outside an EnginexProvider.
Example
ts
const status = useRealtimeStatus()
if (status === 'reconnecting') return <Banner>Reconnecting...</Banner>