interface AgentOptions

extends Partial<TcpSocketConnectOpts>

Properties #

#keepAlive: boolean | undefined

optional

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

#keepAliveMsecs: number | undefined

optional

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.

#maxSockets: number | undefined

optional

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

#maxTotalSockets: number | undefined

optional

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

#maxFreeSockets: number | undefined

optional

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

#timeout: number | undefined

optional

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

#scheduling: "fifo"
 | "lifo"
 | undefined

optional

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