Interface WSOptions

interface WSOptions {
    automaticOpen?: boolean;
    debug?: boolean;
    protocols?: string | string[];
    retry?: OperationOptions;
    shouldRetry?: ShouldRetryFn;
    timeout?: number;
    ws?: new (url: string | URL, protocols?: string | string[]) => WebSocket;
}

Properties

automaticOpen? debug? protocols? retry? shouldRetry? timeout? ws?

Properties

OptionalautomaticOpen

automaticOpen?: boolean

Automatically open the connection

Default

true

Optionaldebug

debug?: boolean

Enable debug mode. This will log all events to the console.

DEBUG=iso-web:ws node test.js will also enable debug mode

Default

false

Optionalprotocols

protocols?: string | string[]

See

https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket#protocols

Optionalretry

retry?: OperationOptions

Retry options

See

https://github.com/tim-kos/node-retry?tab=readme-ov-file#retryoperationoptions

OptionalshouldRetry

shouldRetry?: ShouldRetryFn

Function to determine if the connection should be retried

Retries by default on all close events except 1008 (HTTP 400 equivalent) and 1011 (HTTP 500 equivalent) and connection timeout events

Param: event

The close or connection timeout event

Optionaltimeout

timeout?: number

Timeout in milliseconds for the connection to be established

Default

5000

Optionalws

ws?: new (url: string | URL, protocols?: string | string[]) => WebSocket

See

https://github.com/sxzz/unws

Settings

Member Visibility

On This Page

Properties