Skip to content

Commit

Permalink
fixup! doc: do not mention TCP in the allowHalfOpen option description
Browse files Browse the repository at this point in the history
  • Loading branch information
lpinca committed Apr 24, 2021
1 parent 825e97d commit 4178938
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
12 changes: 7 additions & 5 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,9 +551,10 @@ changes:
* `options` {Object} Available options are:
* `fd` {number} If specified, wrap around an existing socket with
the given file descriptor, otherwise a new socket will be created.
* `allowHalfOpen` {boolean} Indicates whether to automatically end the
writable side when the readable side ends. See [`net.createServer()`][] and
the [`'end'`][] event for details. **Default:** `false`.
* `allowHalfOpen` {boolean} If set to `false`, then the socket will
automatically end the writable side when the readable side ends. See
[`net.createServer()`][] and the [`'end'`][] event for details. **Default:**
`false`.
* `readable` {boolean} Allow reads on the socket when an `fd` is passed,
otherwise ignored. **Default:** `false`.
* `writable` {boolean} Allow writes on the socket when an `fd` is passed,
Expand Down Expand Up @@ -1295,8 +1296,9 @@ added: v0.5.0
-->

* `options` {Object}
* `allowHalfOpen` {boolean} Indicates whether to automatically end the
writable side when the readable side ends. **Default:** `false`.
* `allowHalfOpen` {boolean} If set to `false`, then the socket will
automatically end the writable side when the readable side ends.
**Default:** `false`.
* `pauseOnConnect` {boolean} Indicates whether the socket should be
paused on incoming connections. **Default:** `false`.
* `connectionListener` {Function} Automatically set as a listener for the
Expand Down
8 changes: 4 additions & 4 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1472,10 +1472,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 to automatically end the writable side when the readable side ends,
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:**
Expand Down

0 comments on commit 4178938

Please sign in to comment.