diff options
| author | Luigi Pinca <luigipinca@gmail.com> | 2021-04-22 20:13:08 +0300 |
|---|---|---|
| committer | Luigi Pinca <luigipinca@gmail.com> | 2021-04-27 20:21:00 +0300 |
| commit | d432386f837751c36e34cdf8a62121c8c392cbe0 (patch) | |
| tree | c2f7332f0564c3c8dfc29c92f6d39aa3eafe635c /doc/api/tls.md | |
| parent | 50bbc4e4039110b7429c182623cbfee4b35993d5 (diff) | |
doc: do not mention TCP in the allowHalfOpen option description
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.
PR-URL: https://github.com/nodejs/node/pull/38360
Fixes: https://github.com/nodejs/node/issues/38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index 432ffff8675..d82ecf733d2 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1473,10 +1473,10 @@ changes: Connection/disconnection/destruction of `socket` is the user's responsibility; calling `tls.connect()` will not cause `net.connect()` to be called. - * `allowHalfOpen` {boolean} If the `socket` option is missing, indicates - whether or not to allow the internally created socket to be half-open, - otherwise the option is ignored. See the `allowHalfOpen` option of - [`net.Socket`][] for details. **Default:** `false`. + * `allowHalfOpen` {boolean} If set to `false`, then the socket will + automatically end the writable side when the readable side ends. If the + `socket` option is set, this option has no effect. See the `allowHalfOpen` + option of [`net.Socket`][] for details. **Default:** `false`. * `rejectUnauthorized` {boolean} If not `false`, the server certificate is verified against the list of supplied CAs. An `'error'` event is emitted if verification fails; `err.code` contains the OpenSSL error code. **Default:** |