From 91255cd732c570f5a9c449c37dd31dfef2c36dd1 Mon Sep 17 00:00:00 2001 From: Dexter Leng Date: Sun, 28 Oct 2018 11:55:22 +0800 Subject: [PATCH] doc: add readable and writable property to Readable and Writable PR-URL: https://github.com/nodejs/node/pull/23933 Reviewed-By: Matteo Collina --- doc/api/stream.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index d5cabbc57eaad5..a98a296077af5e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -463,6 +463,15 @@ process.nextTick(() => { See also: [`writable.cork()`][]. +##### writable.writable + + +* {boolean} + +Is `true` if it is safe to call [`writable.write()`][]. + ##### writable.writableHighWaterMark + +* {boolean} + +Is `true` if it is safe to call [`readable.read()`][]. + ##### readable.readableHighWaterMark -* Returns: {number} +* {number} Returns the value of `highWaterMark` passed when constructing this `Readable`. @@ -1028,7 +1046,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