Interface Options

interface Options {
    allowH2?: boolean;
    autoSelectFamily?: boolean;
    autoSelectFamilyAttemptTimeout?: number;
    bodyTimeout?: number;
    connect?: BuildOptions | connector;
    connections?: null | number;
    connectTimeout?: number;
    headersTimeout?: number;
    idleTimeout?: undefined;
    interceptors?: { Pool?: readonly DispatchInterceptor[] } & OptionsInterceptors;
    keepAlive?: undefined;
    keepAliveMaxTimeout?: number;
    keepAliveTimeout?: number;
    keepAliveTimeoutThreshold?: number;
    localAddress?: string;
    maxCachedSessions?: number;
    maxConcurrentStreams?: number;
    maxHeaderSize?: number;
    maxKeepAliveTimeout?: undefined;
    maxRedirections?: number;
    maxRequestsPerClient?: number;
    maxResponseSize?: number;
    pipelining?: number;
    requestTimeout?: undefined;
    socketPath?: string;
    socketTimeout?: undefined;
    strictContentLength?: boolean;
    tls?: undefined;
    factory(origin: URL, opts: object): Dispatcher;
}

Hierarchy (View Summary)

Properties

allowH2? autoSelectFamily? autoSelectFamilyAttemptTimeout? bodyTimeout? connect? connections? connectTimeout? headersTimeout? idleTimeout? interceptors? keepAlive? keepAliveMaxTimeout? keepAliveTimeout? keepAliveTimeoutThreshold? localAddress? maxCachedSessions? maxConcurrentStreams? maxHeaderSize? maxKeepAliveTimeout? maxRedirections? maxRequestsPerClient? maxResponseSize? pipelining? requestTimeout? socketPath? socketTimeout? strictContentLength? tls?

Methods

factory?

Properties

OptionalallowH2

allowH2?: boolean

Description

Enables support for H2 if the server has assigned bigger priority to it through ALPN negotiation.

Default

false

OptionalautoSelectFamily

autoSelectFamily?: boolean

Enables a family autodetection algorithm that loosely implements section 5 of RFC 8305.

OptionalautoSelectFamilyAttemptTimeout

autoSelectFamilyAttemptTimeout?: number

The amount of time in milliseconds to wait for a connection attempt to finish before trying the next address when using the autoSelectFamily option.

OptionalbodyTimeout

bodyTimeout?: number

The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use 0 to disable it entirely. Default: 300e3 milliseconds (300s).

Optionalconnect

connect?: BuildOptions | connector

TODO

Optionalconnections

connections?: null | number

The max number of clients to create. null if no limit. Default null.

OptionalconnectTimeout

connectTimeout?: number

TODO

OptionalheadersTimeout

headersTimeout?: number

The amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers (Node 14 and above only). Default: 300e3 milliseconds (300s).

OptionalidleTimeout

idleTimeout?: undefined

Deprecated

unsupported idleTimeout, use keepAliveTimeout instead

Optionalinterceptors

interceptors?: { Pool?: readonly DispatchInterceptor[] } & OptionsInterceptors

TODO

OptionalkeepAlive

keepAlive?: undefined

Deprecated

unsupported keepAlive, use pipelining=0 instead

OptionalkeepAliveMaxTimeout

keepAliveMaxTimeout?: number

the maximum allowed idleTimeout, in milliseconds, when overridden by keep-alive hints from the server. Default: 600e3 milliseconds (10min).

OptionalkeepAliveTimeout

keepAliveTimeout?: number

the timeout, in milliseconds, after which a socket without active requests will time out. Monitors time between activity on a connected socket. This value may be overridden by keep-alive hints from the server. Default: 4e3 milliseconds (4s).

OptionalkeepAliveTimeoutThreshold

keepAliveTimeoutThreshold?: number

A number of milliseconds subtracted from server keep-alive hints when overriding idleTimeout to account for timing inaccuracies caused by e.g. transport latency. Default: 1e3 milliseconds (1s).

OptionallocalAddress

localAddress?: string

TODO

OptionalmaxCachedSessions

maxCachedSessions?: number

TODO

OptionalmaxConcurrentStreams

maxConcurrentStreams?: number

Description

Dictates the maximum number of concurrent streams for a single H2 session. It can be overridden by a SETTINGS remote frame.

Default

100

OptionalmaxHeaderSize

maxHeaderSize?: number

The maximum length of request headers in bytes. Default: Node.js' --max-http-header-size or 16384 (16KiB).

OptionalmaxKeepAliveTimeout

maxKeepAliveTimeout?: undefined

Deprecated

unsupported maxKeepAliveTimeout, use keepAliveMaxTimeout instead

OptionalmaxRedirections

maxRedirections?: number

TODO

OptionalmaxRequestsPerClient

maxRequestsPerClient?: number

TODO

OptionalmaxResponseSize

maxResponseSize?: number

Max response body size in bytes, -1 is disabled

Optionalpipelining

pipelining?: number

The amount of concurrent requests to be sent over the single TCP/TLS connection according to RFC7230. Default: 1.

OptionalrequestTimeout

requestTimeout?: undefined

Deprecated

unsupported requestTimeout, use headersTimeout & bodyTimeout instead

OptionalsocketPath

socketPath?: string

TODO

OptionalsocketTimeout

socketTimeout?: undefined

Deprecated

unsupported socketTimeout, use headersTimeout & bodyTimeout instead

OptionalstrictContentLength

strictContentLength?: boolean

If true, an error is thrown when the request content-length header doesn't match the length of the request body. Default: true.

Optionaltls

tls?: undefined

Deprecated

use the connect option instead

Methods

Optionalfactory

  • factory(origin: URL, opts: object): Dispatcher

    Default: (origin, opts) => new Client(origin, opts).

    Parameters

    • origin: URL
    • opts: object

    Returns Dispatcher

Settings

Member Visibility

On This Page

Properties
Methods