Skip to content

Commit 3aea277

Browse files
ckarandeBridgeAR
authored andcommitted
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]>
1 parent f5f238d commit 3aea277

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/api/stream.md

+11
Original file line numberDiff line numberDiff line change
@@ -1136,6 +1136,16 @@ added: v12.9.0
11361136

11371137
Becomes `true` when [`'end'`][] event is emitted.
11381138

1139+
##### readable.readableFlowing
1140+
<!-- YAML
1141+
added: v9.4.0
1142+
-->
1143+
1144+
* {boolean}
1145+
1146+
This property reflects the current state of a `Readable` stream as described
1147+
in the [Stream Three States][] section.
1148+
11391149
##### readable.readableHighWaterMark
11401150
<!-- YAML
11411151
added: v9.3.0
@@ -2778,6 +2788,7 @@ contain multi-byte characters.
27782788
[stream-read]: #stream_readable_read_size
27792789
[stream-resume]: #stream_readable_resume
27802790
[stream-write]: #stream_writable_write_chunk_encoding_callback
2791+
[Stream Three States]: #stream_three_states
27812792
[writable-_destroy]: #stream_writable_destroy_err_callback
27822793
[writable-destroy]: #stream_writable_destroy_error
27832794
[writable-new]: #stream_constructor_new_stream_writable_options

0 commit comments

Comments
 (0)