Interface KeepAliveOptions

packages/rtm-api/src/KeepAlive.ts:6–13

import { ErrorCode, CodedError } from './errors';

export interface KeepAliveOptions {
  logger?: Logger;
  logLevel?: LogLevel;
  /** How long (in ms) to wait before sending a ping message to keep the connection alive */
  clientPingTimeout?: number;
  /** How long (in ms) to wait for the acknowledgement of a ping message before considering the connection dead */
  serverPongTimeout?: number; // NOTE: this must be less than clientPingTimeout
}

/**
 * An object that monitors activity in an RTMClient and generates ping events in an effort to keep its websocket