WebsocketOptions

typedef · Source

WebSocket options (these are left as snake_case to match the API) Type: Object

Properties

agent

optional

agent: AgentOptions

HTTPS Agent options (WS Proxy)

Default: {}

tls

optional

tls: TLSOptions

TLS options for Gateway and voice WebSocket connections

Default: {}

compress

optional

compress: boolean

Whether to compress data sent on the connection

Default: false

properties

optional

properties: WebSocketProperties

Properties to identify the client with

version

optional

version: number

Gateway version to use

Default: 10