Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AgentOptions

Hierarchy

Index

Properties

Properties

Optional ALPNProtocols

ALPNProtocols: string[] | Uint8Array[] | Uint8Array

An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

Optional SNICallback

SNICallback: function

SNICallback(servername, cb) A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

Type declaration

    • (servername: string, cb: function): void

    • Parameters

      • servername: string
      • cb: function

      Returns void

Optional ca

ca: string | Buffer | Array<string | Buffer>

Optional cert

cert: string | Buffer | Array<string | Buffer>

Optional checkServerIdentity

checkServerIdentity: checkServerIdentity

Optional ciphers

ciphers: string

Optional clientCertEngine

clientCertEngine: string

Optional crl

crl: string | Buffer | Array<string | Buffer>

Optional dhparam

dhparam: string | Buffer

Optional ecdhCurve

ecdhCurve: string

Optional enableTrace

enableTrace: boolean

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

default

false

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 | Array<Buffer | Object>

Optional lookup

lookup: net.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 maxVersion

maxVersion: SecureVersion

Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

Optional minDHSize

minDHSize: number

Optional minVersion

minVersion: SecureVersion

Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

Optional passphrase

passphrase: string

Optional path

path: string

Optional pfx

pfx: string | Buffer | Array<string | Buffer | Object>

Optional port

port: number

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional requestCert

requestCert: boolean

If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

Optional secureContext

secureContext: SecureContext

An optional TLS context object from tls.createSecureContext()

Optional secureOptions

secureOptions: number

Optional secureProtocol

secureProtocol: string

Optional servername

servername: string

Optional session

session: Buffer

Optional sessionIdContext

sessionIdContext: string

Optional socket

socket: Socket

Optional timeout

timeout: number

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

Generated using TypeDoc