Skip to content

doc: correct stream Duplex allowHalfOpen doc #14127

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.

Sign up for GitHub

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

Closed
Trott wants to merge 1 commit into from
Closed

doc: correct stream Duplex allowHalfOpen doc #14127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: correct stream Duplex allowHalfOpen doc 
If allowHalfOpen is set to false, the stream will automatically end the
writable side when the readable side ends, but not the other way around.

Fixes: #4044
  • Loading branch information
@Trott
Trott committed Jul 7, 2017
commit dba36668b222d8a424be5e2f0e658adb6913c8d2
4 changes: 2 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1744,8 +1744,8 @@ constructor and implement *both* the `readable._read()` and
* `options` {Object} Passed to both Writable and Readable
constructors. Also has the following fields:
* `allowHalfOpen` {boolean} Defaults to `true`. If set to `false`, then
the stream will automatically end the readable side when the
writable side ends and vice versa.
the stream will automatically end the writable side when the
readable side ends.
* `readableObjectMode` {boolean} Defaults to `false`. Sets `objectMode`
for readable side of the stream. Has no effect if `objectMode`
is `true`.
Expand Down