Type Alias ReconnectingOptions

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

Index

Properties

checkStateMs limitAttempts maxDelay onConnected onDisconnected onError onMessage startDelay

Properties

checkStateMs

checkStateMs: Interval

How often to check the state of the underlying websocket.

Default: 5s

limitAttempts

limitAttempts: number

maxDelay

maxDelay: Interval

onConnected

onConnected: () => void

onDisconnected

onDisconnected: () => void

onError

onError: (error: any) => void

onMessage

onMessage: (message: any) => void

Callback when message is received

Type declaration

- (message: any): void
- Parameters
  - message: any
  Returns void

startDelay

startDelay: Interval