Interface WebSocketsInit

An object that contains an AbortSignal as the optional signal property.

Example

const controller = new AbortController()

aLongRunningOperation({
  signal: controller.signal
})

// later

controller.abort()
interface WebSocketsInit {
    closeOnEnd?: boolean;
    filter?: MultiaddrFilter;
    http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
    https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>;
    inboundConnectionUpgradeTimeout?: number;
    signal?: AbortSignal;
    websocket?: ClientOptions;
}

Hierarchy (view full)

Properties

closeOnEnd? filter? http? https? inboundConnectionUpgradeTimeout? signal? websocket?

Properties

Optional closeOnEnd

closeOnEnd?: boolean

Optional filter

filter?: MultiaddrFilter

Deprecated

Use a ConnectionGater instead

Optional http

http?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

Options used to create the HTTP server

Optional https

https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

Options used to create the HTTPs server. options.http will be used if unspecified.

Optional inboundConnectionUpgradeTimeout

inboundConnectionUpgradeTimeout?: number

Inbound connections must complete their upgrade within this many ms

Default

5000

Optional signal

signal?: AbortSignal

Optional websocket

websocket?: ClientOptions

Options used to create WebSockets

Settings

Member Visibility

Theme

On This Page

closeOnEndfilterhttphttpsinboundConnectionUpgradeTimeoutsignalwebsocket