Skip to main content

CommonConnectionOptions

interface CommonConnectionOptions

Properties Jump to heading

An optional TLS context object from tls.createSecureContext()

optional
Jump to headingenableTrace: boolean | undefined

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

optional
Jump to headingrequestCert: boolean | undefined

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

optional
Jump to headingALPNProtocols:
string[]
| Uint8Array[]
| Uint8Array
| undefined

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

optional
Jump to headingSNICallback: ((
servername: string,
cb: (
err: Error | null,
) => void,
) => void) | undefined

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

optional
Jump to headingrejectUnauthorized: boolean | undefined

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.

Back to top