Node: Document tls.Server#listen(path, callback) and possible other signatures

Created on 18 Mar 2017  路  5Comments  路  Source: nodejs/node

We currently support unix sockets on https.Server and net.Server, but for some reason not on tls.Server. Seems like an oversight to me, would anyone agree?

doc help wanted tls

All 5 comments

I agree, I would have expected it to work.

Looks like it actually already works. I'm able to connect to a TLS unix socket using OpenSSL 1.1.1.

Flagging this as documentation issue. We're likely missing a few .listen signatures in TLS.

Hey there,
Would y'all mind if I took on this issue? It's my first contribution to an OSS project and would love to do it if it's still available.

Sure, go ahead. What needs to be tested is if these method signatures from net#Server are also available on a tls#Server:

https://nodejs.org/api/net.html#net_server_listen_handle_backlog_callback
https://nodejs.org/api/net.html#net_server_listen_options_callback
https://nodejs.org/api/net.html#net_server_listen_path_backlog_callback

I guess it's best to link to the net counterparts instead of duplicating information.

This has been addressed by https://github.com/nodejs/node/pull/16020

Was this page helpful?
0 / 5 - 0 ratings