Interface AgentOptions

interface AgentOptions {
    keepAlive?: boolean;
    keepAliveMsecs?: number;
    maxSockets?: number;
    maxTotalSockets?: number;
    maxFreeSockets?: number;
    timeout?: number;
    scheduling?: "fifo" | "lifo";
    port?: number;
    host?: string;
    localAddress?: string;
    localPort?: number;
    hints?: number;
    family?: number;
    lookup?: LookupFunction;
    noDelay?: boolean;
    keepAliveInitialDelay?: number;
    autoSelectFamily?: boolean;
    autoSelectFamilyAttemptTimeout?: number;
    blockList?: BlockList;
}

Hierarchy (view full)

Properties

keepAlive? keepAliveMsecs? maxSockets? maxTotalSockets? maxFreeSockets? timeout? scheduling? port? host? localAddress? localPort? hints? family? lookup? noDelay? keepAliveInitialDelay? autoSelectFamily? autoSelectFamilyAttemptTimeout? blockList?

Properties

OptionalkeepAlive

keepAlive?: boolean

Keep sockets around in a pool to be used by other requests in the future. Default = false

OptionalkeepAliveMsecs

keepAliveMsecs?: number

When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

OptionalmaxSockets

maxSockets?: number

Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

OptionalmaxTotalSockets

maxTotalSockets?: number

Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

OptionalmaxFreeSockets

maxFreeSockets?: number

Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

Optionaltimeout

timeout?: number

Socket timeout in milliseconds. This will set the timeout after the socket is connected.

Optionalscheduling

scheduling?: "fifo" | "lifo"

Scheduling strategy to apply when picking the next free socket to use.

Default

lifo

Optionalport

port?: number

Optionalhost

host?: string

OptionallocalAddress

localAddress?: string

OptionallocalPort

localPort?: number

Optionalhints

hints?: number

Optionalfamily

family?: number

Optionallookup

lookup?: LookupFunction

OptionalnoDelay

noDelay?: boolean

OptionalkeepAliveInitialDelay

keepAliveInitialDelay?: number

OptionalautoSelectFamily

autoSelectFamily?: boolean

Since

v18.13.0

OptionalautoSelectFamilyAttemptTimeout

autoSelectFamilyAttemptTimeout?: number

Since

v18.13.0

OptionalblockList

blockList?: BlockList

Settings

Member Visibility

On This Page

Properties