Interface CommonConnectionOptions

interface CommonConnectionOptions {
    secureContext?: SecureContext;
    enableTrace?: boolean;
    requestCert?: boolean;
    ALPNProtocols?: readonly string[] | ArrayBufferView;
    SNICallback?: ((servername: string, cb: ((err: null | Error, ctx?: SecureContext) => void)) => void);
    rejectUnauthorized?: boolean;
}

Hierarchy (view full)

Properties

secureContext? enableTrace? requestCert? ALPNProtocols? SNICallback? rejectUnauthorized?

Properties

OptionalsecureContext

secureContext?: SecureContext

An optional TLS context object from tls.createSecureContext()

OptionalenableTrace

enableTrace?: boolean

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

Default

false

OptionalrequestCert

requestCert?: boolean

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

OptionalALPNProtocols

ALPNProtocols?: readonly string[] | ArrayBufferView

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

OptionalSNICallback

SNICallback?: ((servername: string, cb: ((err: null | Error, ctx?: SecureContext) => void)) => void)

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).

OptionalrejectUnauthorized

rejectUnauthorized?: boolean

If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

Default

true

Settings

Member Visibility

On This Page

Properties