From 199ad1d73f81c1d568232df418090e9ce3c4a7fb Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 7 Jul 2017 13:44:53 -0700 Subject: [PATCH] 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. PR-URL: https://github.com/nodejs/node/pull/14127 Fixes: https://github.com/nodejs/node/issues/4044 Reviewed-By: Luigi Pinca Reviewed-By: Matteo Collina Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- doc/api/stream.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index f6e28c1022..042685fd99 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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`.