From 55cf80bfe2fa33f2b1f9f118b18abc60786b4f23 Mon Sep 17 00:00:00 2001 From: Dexter Leng Date: Sun, 28 Oct 2018 11:55:22 +0800 Subject: [PATCH 1/4] doc: add readable and writable property to Readable and Writable --- doc/api/stream.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/api/stream.md b/doc/api/stream.md index fb2f2da28d1a87..f17b578f29a1c8 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -463,6 +463,16 @@ process.nextTick(() => { See also: [`writable.cork()`][]. +##### writable.writable + + +* {boolean} + +A boolean that is `true` by default, but turns `false` after the +[`stream.end()`][stream-end] method has been called. + ##### writable.writableHighWaterMark + +* {boolean} + +A boolean that is `true` by default, but turns `false` immediately before the `'end'` event is emitted. + ##### readable.readableHighWaterMark -* Returns: {number} +* {number} Returns the value of `highWaterMark` passed when constructing this `Readable`. @@ -1047,7 +1047,7 @@ Returns the value of `highWaterMark` passed when constructing this added: v9.4.0 --> -* Returns: {number} +* {number} This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding From 8c4ccca54a5db8cb6fcf94a2d8fa1c2c0fd614d9 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Mon, 29 Oct 2018 23:07:47 +0800 Subject: [PATCH 3/4] doc: address comment Co-Authored-By: dexterleng <34204380+dexterleng@users.noreply.github.com> --- doc/api/stream.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 73fe1a9ffc8a7c..8824eb28cb9a03 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1030,7 +1030,8 @@ added: REPLACEME * {boolean} -A boolean that is `true` by default, but turns `false` immediately before the `'end'` event is emitted. +A boolean that is `true` by default, but turns `false` immediately before +the `'end'` event is emitted. ##### readable.readableHighWaterMark