◐ Shell
clean mode source ↗

tls: inconsistency between doc and code for createSecureContext() options in TLSSocket constructor

  • Version: 7.3
  • Platform: Any
  • Subsystem: Any

In current TLS doc, when documenting options argument of the constructor of TLSSocket, it says

...: Optional tls.createSecureContext() options can be provided, see the secureContext option for more information. Construct a new tls.TLSSocket object from an existing TCP socket.

However, in line 351 of _tls_wrap.js, tls.createSecureContext() is called without arguments at all. This inconsistency is introduced in caa7fa9. Either the doc or the code must be changed to match.

In my opinion I believe that what is described in the doc is sensible, but I believe that a community consensus must be reached to actually decide the correct behavior.