Github Link
      ⚠️ Internal: This API is not publically exported by the package.

      Interface CommonConnectionOptions

      interface CommonConnectionOptions {
          ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
          SNICallback?: ((servername, cb) => void);
          enableTrace?: boolean;
          rejectUnauthorized?: boolean;
          requestCert?: boolean;
          secureContext?: SecureContext;
      }

      Hierarchy

      Properties

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

      Properties

      Optional ALPNProtocols

      ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

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

      Optional SNICallback

      SNICallback?: ((servername, cb) => void)

      Type declaration

        • (servername, cb): 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).

          Parameters

          • servername: string
          • cb: ((err, ctx?) => void)

          Returns void

      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 rejectUnauthorized

      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

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

      Settings

      Member Visibility

      Theme

      On This Page