doc: add documentation for stream readableFlowing

PR-URL: #29506 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Sep 25, 2019 · 3aea277 · 3aea277
1 parent f5f238d
commit 3aea277
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1136,6 +1136,16 @@ added: v12.9.0
 
 Becomes `true` when [`'end'`][] event is emitted.
 
+##### readable.readableFlowing
+<!-- YAML
+added: v9.4.0
+-->
+
+* {boolean}
+
+This property reflects the current state of a `Readable` stream as described
+in the [Stream Three States][] section.
+
 ##### readable.readableHighWaterMark
 <!-- YAML
 added: v9.3.0
@@ -2778,6 +2788,7 @@ contain multi-byte characters.
 [stream-read]: #stream_readable_read_size
 [stream-resume]: #stream_readable_resume
 [stream-write]: #stream_writable_write_chunk_encoding_callback
+[Stream Three States]: #stream_three_states
 [writable-_destroy]: #stream_writable_destroy_err_callback
 [writable-destroy]: #stream_writable_destroy_error
 [writable-new]: #stream_constructor_new_stream_writable_options