-
Notifications
You must be signed in to change notification settings - Fork 30k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: do not mention TCP in the allowHalfOpen option description #38360
Conversation
The `allowHalfOpen` option works in the same way for both TCP and IPC connections. Fixes: nodejs#38307
doc/api/net.md
Outdated
* `allowHalfOpen` {boolean} Indicates whether to automatically end the | ||
writable side when the readable side ends. See [`net.createServer()`][] and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this make it sound like you should set it to true
to automatically end the writable side when in fact the opposite is true?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Indicates whether to not automatically end the writable side when the readable side ends.
- Indicates whether to keep the writable side open when the readable side ends.
- Other suggestions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL, I've used the same wording used here https://nodejs.org/api/stream.html#stream_new_stream_duplex_options.
Landed in d432386. |
The
allowHalfOpen
option works in the same way for both TCP and IPCconnections.
Fixes: #38307