Type Alias DispatcherOptions

Options for the default undici Dispatcher; unset fields use undici defaults.

type DispatcherOptions = {
    keepAliveTimeMillis?: number;
    maxConnections?: number;
    maxResponseHeaderBytes?: number;
    proxy?: string;
    readTimeoutMillis?: number;
}

Properties

keepAliveTimeMillis?: number

Idle ms before TCP keep-alive probes begin. Defaults to 30s; 0 disables keep-alive.

maxConnections?: number

Max concurrent connections per origin. Defaults to DEFAULT_MAX_CONNECTIONS.

maxResponseHeaderBytes?: number

Max response header size in bytes. Maps to undici maxHeaderSize.

proxy?: string

HTTP proxy URI. When set, a ProxyAgent is built instead of an Agent.

readTimeoutMillis?: number

Read timeout in ms. Maps to undici headersTimeout (wait for first response byte) and bodyTimeout (idle between body chunks).