diff options
| author | Bryan English <bryan@bryanenglish.com> | 2017-07-31 23:58:39 -0700 |
|---|---|---|
| committer | Bryan English <bryan@bryanenglish.com> | 2017-09-22 16:30:24 -0700 |
| commit | 6f1caadb85f70bb902c078d9b7a96e3c4b36b31f (patch) | |
| tree | ad1165f719cab051dff608e04b6b602a6dc3a9aa /doc/api/net.md | |
| parent | ba5a668c39cb7a70c174187a13c547aae4328682 (diff) | |
| download | android-node-v8-6f1caadb85f70bb902c078d9b7a96e3c4b36b31f.tar.gz android-node-v8-6f1caadb85f70bb902c078d9b7a96e3c4b36b31f.tar.bz2 android-node-v8-6f1caadb85f70bb902c078d9b7a96e3c4b36b31f.zip | |
tls: prefer path over port in connect
Makes tls.connect() behave as documented, preferring options.path over
options.port. This makes it consistent with net.connect(), so the
included test demonstrates that both behave in this way.
Also, for consistency, noting the precedence of options.path in net
doc.
PR-URL: https://github.com/nodejs/node/pull/14564
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index 2c5a05e2dc..4ed0dbda6c 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -591,7 +591,8 @@ For TCP connections, available `options` are: For [IPC][] connections, available `options` are: * `path` {string} Required. Path the client should connect to. - See [Identifying paths for IPC connections][]. + See [Identifying paths for IPC connections][]. If provided, the TCP-specific + options above are ignored. Returns `socket`. |