doc: add readable and writable property to Readable and Writable

PR-URL: #23933 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
nodejs · Oct 28, 2018 · 41f2e36046e441106b14ededdcc80b1172c6ff78 · 41f2e36
1 parent 4792bea
commit 41f2e36046e441106b14ededdcc80b1172c6ff78
Unified Split

Showing with 20 additions and 2 deletions.

+20 −2 doc/api/stream.md
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -463,6 +463,15 @@ process.nextTick(() => {
 See also: [`writable.cork()`][].
+  
+##### writable.writable
+  
+<!-- YAML
+  
+added: REPLACEME
+  
+-->
+  
+
+  
+* {boolean}
+  
+
+  
+Is `true` if it is safe to call [`writable.write()`][].
+  
+
 ##### writable.writableHighWaterMark
 <!-- YAML
 added: v9.3.0
@@ -1013,12 +1022,21 @@ also be emitted.
 Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has
 been emitted will return `null`. No runtime error will be raised.
+  
+##### readable.readable
+  
+<!-- YAML
+  
+added: REPLACEME
+  
+-->
+  
+
+  
+* {boolean}
+  
+
+  
+Is `true` if it is safe to call [`readable.read()`][].
+  
+
 ##### readable.readableHighWaterMark
 <!-- YAML
 added: v9.3.0
 -->
-  
-* 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