Interface ClientRequestArgs

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

Properties

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

Properties

Optional _defaultAgent

_defaultAgent?: Agent

Optional agent

agent?: boolean | Agent

Optional auth

auth?: null | string

Optional createConnection

createConnection?: ((options, oncreate) => undefined | null | Duplex)

Type declaration

    • (options, oncreate): undefined | null | Duplex

    • Parameters

      Returns undefined | null | Duplex

Optional defaultPort

defaultPort?: string | number

Optional family

family?: number

Optional headers

headers?: OutgoingHttpHeaders

Optional hints

hints?: number

Optional host

host?: null | string

Optional hostname

hostname?: null | string

Optional insecureHTTPParser

insecureHTTPParser?: boolean

Optional joinDuplicateHeaders

joinDuplicateHeaders?: boolean

Optional localAddress

localAddress?: string

Optional localPort

localPort?: number

Optional lookup

lookup?: LookupFunction

Optional maxHeaderSize

maxHeaderSize?: number

Default

16384

Optional method

method?: string

Optional path

path?: null | string

Optional port

port?: null | string | number

Optional protocol

protocol?: null | string

Optional setHost

setHost?: boolean

Optional signal

signal?: AbortSignal

Optional socketPath

socketPath?: string

Optional timeout

timeout?: number

Optional uniqueHeaders

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

Settings

Member Visibility

Theme

On This Page

_defaultAgentagentauthcreateConnectiondefaultPortfamilyheadershintshosthostnameinsecureHTTPParserjoinDuplicateHeaderslocalAddresslocalPortlookupmaxHeaderSizemethodpathportprotocolsetHostsignalsocketPathtimeoutuniqueHeaders