livekit-client/src/room/ReconnectPolicy.ts

JavaScript/TypeScript client SDK for LiveKit

/** Controls reconnecting of the client */
export interface ReconnectPolicy {
  /** Called after disconnect was detected
   *
   * @returns {number | null} Amount of time in milliseconds to delay the next reconnect attempt, `null` signals to stop retrying.
   */
  nextRetryDelayInMs(context: ReconnectContext): number | null;
}

export interface ReconnectContext {
  /**
   * Number of failed reconnect attempts
   */
  readonly retryCount: number;

  /**
   * Elapsed amount of time in milliseconds since the disconnect.
   */
  readonly elapsedMs: number;

  /**
   * Reason for retrying
   */
  readonly retryReason?: Error;

  readonly serverUrl?: string;
}