Interface AgentOptions

interface AgentOptions {
    ALPNProtocols?: string[] | Buffer | Uint8Array<ArrayBufferLike> | Buffer[] | Uint8Array<ArrayBufferLike>[];
    NPNProtocols?: string[] | Buffer | Uint8Array<ArrayBufferLike> | Buffer[] | Uint8Array<ArrayBufferLike>[];
    ca?: string | Buffer | (string | Buffer)[];
    cert?: string | Buffer | (string | Buffer)[];
    checkServerIdentity?: ((host, cert) => Error | undefined);
    ciphers?: string;
    crl?: string | Buffer | (string | Buffer)[];
    dhparam?: string | Buffer;
    ecdhCurve?: string;
    honorCipherOrder?: boolean;
    host?: string;
    keepAlive?: boolean;
    keepAliveMsecs?: number;
    key?: string | Buffer | (Object | Buffer)[];
    lookup?: LookupFunction;
    maxCachedSessions?: number;
    maxFreeSockets?: number;
    maxSockets?: number;
    minDHSize?: number;
    passphrase?: string;
    path?: string;
    pfx?: string | Buffer | (string | Object | Buffer)[];
    port?: number;
    rejectUnauthorized?: boolean;
    secureContext?: SecureContext;
    secureOptions?: number;
    secureProtocol?: string;
    servername?: string;
    session?: Buffer;
    sessionIdContext?: string;
    socket?: Socket;
}

Hierarchy (view full)

Properties

ALPNProtocols? NPNProtocols? ca? cert? checkServerIdentity? ciphers? crl? dhparam? ecdhCurve? honorCipherOrder? host? keepAlive? keepAliveMsecs? key? lookup? maxCachedSessions? maxFreeSockets? maxSockets? minDHSize? passphrase? path? pfx? port? rejectUnauthorized? secureContext? secureOptions? secureProtocol? servername? session? sessionIdContext? socket?

Properties

Optional ALPNProtocols

ALPNProtocols?: string[] | Buffer | Uint8Array<ArrayBufferLike> | Buffer[] | Uint8Array<ArrayBufferLike>[]

Optional NPNProtocols

NPNProtocols?: string[] | Buffer | Uint8Array<ArrayBufferLike> | Buffer[] | Uint8Array<ArrayBufferLike>[]

Optional ca

ca?: string | Buffer | (string | Buffer)[]

Optional cert

cert?: string | Buffer | (string | Buffer)[]

Optional checkServerIdentity

checkServerIdentity?: ((host, cert) => Error | undefined)

Type declaration

    • (host, cert): Error | undefined

    • Parameters

      Returns Error | undefined

Optional ciphers

ciphers?: string

Optional crl

crl?: string | Buffer | (string | Buffer)[]

Optional dhparam

dhparam?: string | Buffer

Optional ecdhCurve

ecdhCurve?: string

Optional honorCipherOrder

honorCipherOrder?: boolean

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 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 key

key?: string | Buffer | (Object | Buffer)[]

Optional lookup

lookup?: LookupFunction

Optional maxCachedSessions

maxCachedSessions?: number

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 minDHSize

minDHSize?: number

Optional passphrase

passphrase?: string

Optional path

path?: string

Optional pfx

pfx?: string | Buffer | (string | Object | Buffer)[]

Optional port

port?: number

Optional rejectUnauthorized

rejectUnauthorized?: boolean

Optional secureContext

secureContext?: SecureContext

Optional secureOptions

secureOptions?: number

Optional secureProtocol

secureProtocol?: string

Optional servername

servername?: string

Optional session

session?: Buffer

Optional sessionIdContext

sessionIdContext?: string

Optional socket

socket?: Socket

Settings

Member Visibility

Theme

On This Page