Monitor connection status

Monitor real-time connection status changes to provide users with feedback about their connectivity.

Add a connection status listener

Use NCEngine.addConnectionStatusHandler to listen for connection status changes.

TypeScript

import { NCEngine, ConnectionStatusHandler } from '@nexconn/chat';

NCEngine.addConnectionStatusHandler('my-handler', new ConnectionStatusHandler({
  onConnectionStatusChanged({ status, code }) {
    console.log('Connection status:', status, 'code:', code);
  },
}));

ConnectionStatusChangedEvent fields

ConnectionStatusHandler exposes a single callback, onConnectionStatusChanged, whose argument has the shape { status, code? }:

Field	Type	Description
status	ConnectionStatus	Current connection state (numeric ConnectionStatus enum).
code	number (optional)	Extra reason or error code when the engine supplies one.

For typical status values and for business error codes that may appear in code, see Status codes and the ConnectionStatus API reference.

Remove a connection status listener

TypeScript

NCEngine.removeConnectionStatusHandler('my-handler');

tip

Register the connection status listener before calling connect to capture all status transitions, including the initial connecting state.