@ably/chat/src/react/types/chat-status-response.ts

Ably Chat is a set of purpose-built APIs for a host of chat features enabling you to create 1:1, 1:Many, Many:1 and Many:Many chat rooms for any scale. It is designed to meet a wide range of chat use cases, such as livestreams, in-game communication, cust

import * as Ably from 'ably';

import { ConnectionStatus } from '../../core/connection.js';
import { RoomStatus } from '../../core/room-status.js';

/**
 * Common status variables for chat features. Most hooks in this library
 * implement this interface.
 */
export interface ChatStatusResponse {
  /** Provides the connection status of the Ably connection. */
  readonly connectionStatus: ConnectionStatus;

  /** If there's a connection error it will be available here.  */
  readonly connectionError?: Ably.ErrorInfo;

  /** Provides the status of the room. */
  readonly roomStatus: RoomStatus;

  /** If there's an error with the room it will be available here. */
  readonly roomError?: Ably.ErrorInfo;
}