Skip to main content

AgentOptions

interface AgentOptions
extends Partial<TcpSocketConnectOpts>

Properties Jump to heading

optional
Jump to headingkeepAlive: boolean | undefined

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

optional
Jump to headingkeepAliveMsecs: number | undefined

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.

optional
Jump to headingmaxSockets: number | undefined

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

optional
Jump to headingmaxTotalSockets: number | undefined

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

optional
Jump to headingmaxFreeSockets: number | undefined

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

optional
Jump to headingtimeout: number | undefined

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

optional
Jump to headingscheduling:
"fifo"
| "lifo"
| undefined

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

Back to top