Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientOptions

Client options object

Hierarchy

  • ClientOptions

Index

Properties

Properties

ackRateLimiter

ackRateLimiter: boolean

apiURL

apiURL: string

autoReconnect

autoReconnect: boolean

cache

cache: boolean

debug

debug: boolean

heartbeat

heartbeat: number

Optional onPongTimeout

onPongTimeout: "EXIT" | "RECONNECT"

If pongTimeout is set, this decides what to do when the timeout is triggered. Default is RECONNECT.

Optional pongTimeout

pongTimeout: number

Automatically reconnect the client if no pong is received after X seconds of sending a ping. This is a temporary fix for an issue where the client would randomly stop receiving websocket messages.

unreads

unreads: boolean

Generated using TypeDoc