Interface HttpRequestOptions

interface HttpRequestOptions {
    _defaultAgent?: Agent;
    agent?: boolean | Agent;
    auth?: string;
    createConnection?: ((options: ClientRequestArgs, oncreate: ((err: Error, socket: Socket) => void)) => Socket);
    defaultPort?: string | number;
    family?: number;
    headers?: OutgoingHttpHeaders;
    host?: string;
    hostname?: string;
    localAddress?: string;
    lookup?: LookupFunction;
    maxHeaderSize?: number;
    method?: string;
    path?: string;
    port?: string | number;
    protocol?: string;
    searchParams?: {
        [key: string]: string;
    };
    setHost?: boolean;
    signal?: AbortSignal;
    socketPath?: string;
    timeout?: number;
    url?: string;
}

Hierarchy

  • RequestOptions
    • HttpRequestOptions

Properties

_defaultAgent? agent? auth? createConnection? defaultPort? family? headers? host? hostname? localAddress? lookup? maxHeaderSize? method? path? port? protocol? searchParams? setHost? signal? socketPath? timeout? url?

Properties

Optional_defaultAgent

_defaultAgent?: Agent

Optionalagent

agent?: boolean | Agent

Optionalauth

auth?: string

OptionalcreateConnection

createConnection?: ((options: ClientRequestArgs, oncreate: ((err: Error, socket: Socket) => void)) => Socket)

OptionaldefaultPort

defaultPort?: string | number

Optionalfamily

family?: number

Optionalheaders

headers?: OutgoingHttpHeaders

Optionalhost

host?: string

Optionalhostname

hostname?: string

OptionallocalAddress

localAddress?: string

Optionallookup

lookup?: LookupFunction

OptionalmaxHeaderSize

maxHeaderSize?: number

Default

8192

Optionalmethod

method?: string

Optionalpath

path?: string

Optionalport

port?: string | number

Optionalprotocol

protocol?: string

OptionalsearchParams

searchParams?: {
    [key: string]: string;
}

OptionalsetHost

setHost?: boolean

Optionalsignal

signal?: AbortSignal

OptionalsocketPath

socketPath?: string

Optionaltimeout

timeout?: number

Optionalurl

url?: string

Settings

Member Visibility

On This Page

Properties