Interface RequestOptions

From T, pick a set of properties whose keys are in the union K

interface RequestOptions {
    hints?: number;
    _defaultAgent?: Agent;
    agent?: boolean | Agent;
    auth?: null | string;
    createConnection?: ((options: ClientRequestArgs, oncreate: ((err: null | Error, socket: Duplex) => void)) => undefined | null | Duplex);
    defaultPort?: string | number;
    family?: number;
    headers?: readonly string[] | OutgoingHttpHeaders;
    host?: null | string;
    hostname?: null | string;
    insecureHTTPParser?: boolean;
    localAddress?: string;
    localPort?: number;
    lookup?: LookupFunction;
    maxHeaderSize?: number;
    method?: string;
    path?: null | string;
    port?: null | string | number;
    protocol?: null | string;
    setDefaultHeaders?: boolean;
    setHost?: boolean;
    signal?: AbortSignal;
    socketPath?: string;
    timeout?: number;
    uniqueHeaders?: (string | string[])[];
    joinDuplicateHeaders?: boolean;
}

Hierarchy (view full)

Properties

hints? _defaultAgent? agent? auth? createConnection? defaultPort? family? headers? host? hostname? insecureHTTPParser? localAddress? localPort? lookup? maxHeaderSize? method? path? port? protocol? setDefaultHeaders? setHost? signal? socketPath? timeout? uniqueHeaders? joinDuplicateHeaders?

Properties

Optionalhints

hints?: number

One or more supported getaddrinfo flags. Multiple flags may be passed by bitwise ORing their values.

Optional_defaultAgent

_defaultAgent?: Agent

Optionalagent

agent?: boolean | Agent

Optionalauth

auth?: null | string

OptionalcreateConnection

createConnection?: ((options: ClientRequestArgs, oncreate: ((err: null | Error, socket: Duplex) => void)) => undefined | null | Duplex)

OptionaldefaultPort

defaultPort?: string | number

Optionalfamily

family?: number

Optionalheaders

headers?: readonly string[] | OutgoingHttpHeaders

Optionalhost

host?: null | string

Optionalhostname

hostname?: null | string

OptionalinsecureHTTPParser

insecureHTTPParser?: boolean

OptionallocalAddress

localAddress?: string

OptionallocalPort

localPort?: number

Optionallookup

lookup?: LookupFunction

OptionalmaxHeaderSize

maxHeaderSize?: number

Default

16384

Optionalmethod

method?: string

Optionalpath

path?: null | string

Optionalport

port?: null | string | number

Optionalprotocol

protocol?: null | string

OptionalsetDefaultHeaders

setDefaultHeaders?: boolean

OptionalsetHost

setHost?: boolean

Optionalsignal

signal?: AbortSignal

OptionalsocketPath

socketPath?: string

Optionaltimeout

timeout?: number

OptionaluniqueHeaders

uniqueHeaders?: (string | string[])[]

OptionaljoinDuplicateHeaders

joinDuplicateHeaders?: boolean

Settings

Member Visibility

On This Page

Properties