Type Alias ReconnectingOptions

ReconnectingOptions: {
    checkStateMs: Interval;
    limitAttempts: number;
    maxDelay: Interval;
    onConnected: (() => void);
    onDisconnected: (() => void);
    onError: ((error: any) => void);
    onMessage: ((message: any) => void);
    startDelay: Interval;
}

Type declaration

  • checkStateMs: Interval

    How often to check the state of the underlying websocket.

    Default: 5s

  • limitAttempts: number
  • maxDelay: Interval
  • onConnected: (() => void)
      • (): void
      • Returns void

  • onDisconnected: (() => void)
      • (): void
      • Returns void

  • onError: ((error: any) => void)
      • (error): void
      • Parameters

        • error: any

        Returns void

  • onMessage: ((message: any) => void)

    Callback when message is received

      • (message): void
      • Parameters

        • message: any

        Returns void

  • startDelay: Interval