Interface Options

WsTransport.connect options.

interface Options {
    connectTimeout?: number;
    highWaterMark?: number;
    lowWaterMark?: number;
}

Properties

connectTimeout? highWaterMark? lowWaterMark?

Properties

Optional connectTimeout

connectTimeout?: number

Connect timeout (in milliseconds).

Default Value

10000

Optional highWaterMark

highWaterMark?: number

Buffer amount (in bytes) to start TX throttling.

Default Value

1 MiB

Optional lowWaterMark

lowWaterMark?: number

Buffer amount (in bytes) to stop TX throttling.

Default Value

16 KiB

Settings

Member Visibility

Theme

On This Page

connectTimeouthighWaterMarklowWaterMark