Interface UpgradeOptions

interface UpgradeOptions {
    headers?: null | string[] | IncomingHttpHeaders;
    maxRedirections?: number;
    method?: string;
    path: string;
    protocol?: string;
    redirectionLimitReached?: boolean;
    responseHeader?: null | "raw";
    signal?: unknown;
}

Index

Properties

headers? maxRedirections? method? path protocol? redirectionLimitReached? responseHeader? signal?

Properties

`Optional` headers

headers?: null | string[] | IncomingHttpHeaders

Default: null

`Optional` maxRedirections

maxRedirections?: number

Default: 0

`Optional` method

method?: string

Default: 'GET'

path

path: string

`Optional` protocol

protocol?: string

A string of comma separated protocols, in descending preference order. Default: 'Websocket'

`Optional` redirectionLimitReached

redirectionLimitReached?: boolean

Default: false

`Optional` responseHeader

responseHeader?: null | "raw"

Default: null

`Optional` signal

signal?: unknown

Default: null