Skip to main content

Interface: WebSocketOptions

Defined in: src/types/options.ts:221

WebSocket options

Properties​

auth?​

optional auth?: AuthType

Defined in: src/types/options.ts:227

Authentication

autoReconnect?​

optional autoReconnect?: boolean

Defined in: src/types/options.ts:237

Auto-reconnect on disconnect

cookies?​

optional cookies?: CookiesInit

Defined in: src/types/options.ts:225

Request cookies

headers?​

optional headers?: HeadersInit

Defined in: src/types/options.ts:223

Request headers

impersonate?​

optional impersonate?: string

Defined in: src/types/options.ts:233

Browser to impersonate

maxMessageSize?​

optional maxMessageSize?: number

Defined in: src/types/options.ts:243

Maximum message size in bytes (default: 64MB)

maxReconnectAttempts?​

optional maxReconnectAttempts?: number

Defined in: src/types/options.ts:239

Maximum reconnect attempts

proxy?​

optional proxy?: string

Defined in: src/types/options.ts:229

Proxy URL

reconnectDelay?​

optional reconnectDelay?: number

Defined in: src/types/options.ts:241

Reconnect delay in milliseconds

timeout?​

optional timeout?: number

Defined in: src/types/options.ts:235

Connection timeout in seconds

verify?​

optional verify?: boolean

Defined in: src/types/options.ts:231

Verify SSL certificates (default: true)