Interface ClientOptions

Options for initializing a new client.

Hierarchy

  • ClientOptions

Properties

apiURL debug exitOnTimeout? heartbeat pingTimeout? reconnect

Properties

apiURL

apiURL: string

The API URL to connect to. (default: https://api.revolt.chat)

debug

debug: boolean

Enable debug mode (currently does nothing). (default: false)

Optional exitOnTimeout

exitOnTimeout?: boolean

If enabled, will throw an error if a Pong packet is not received by pingTimeout

heartbeat

heartbeat: number

If set to >0, send Ping packet every heartbeat seconds. (default: 30)

Optional pingTimeout

pingTimeout?: number

Maximum amount of time to wait (in seconds) for a Pong packet from the websocket after a Ping has been sent.

reconnect

reconnect: boolean

Automatically reconnect the bot on disconnect. (default: true)