Interface AgentOptions

Make all properties in T optional

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

Hierarchy (view full)

Properties

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

Properties

Optional autoSelectFamily

autoSelectFamily?: boolean

Since

v18.13.0

Optional autoSelectFamilyAttemptTimeout

autoSelectFamilyAttemptTimeout?: number

Since

v18.13.0

Optional family

family?: number

Optional hints

hints?: number

Optional host

host?: string

Optional keepAlive

keepAlive?: boolean

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

Optional keepAliveInitialDelay

keepAliveInitialDelay?: number

Optional keepAliveMsecs

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.

Optional localAddress

localAddress?: string

Optional localPort

localPort?: number

Optional lookup

lookup?: LookupFunction

Optional maxFreeSockets

maxFreeSockets?: number

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

Optional maxSockets

maxSockets?: number

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

Optional maxTotalSockets

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.

Optional noDelay

noDelay?: boolean

Optional onread

onread?: OnReadOpts

If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.

Optional port

port?: number

Optional scheduling

scheduling?: "fifo" | "lifo"

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

Default

lifo

Optional timeout

timeout?: number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc