Skip to content

Commit 7b32654

Browse files
ckarandeTrott
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 df0e2e3 commit 7b32654

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/api/stream.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1139,6 +1139,16 @@ added: v12.9.0
11391139

11401140
Becomes `true` when [`'end'`][] event is emitted.
11411141

1142+
##### readable.readableFlowing
1143+
<!-- YAML
1144+
added: v9.4.0
1145+
-->
1146+
1147+
* {boolean}
1148+
1149+
This property reflects the current state of a `Readable` stream as described
1150+
in the [Stream Three States][] section.
1151+
11421152
##### readable.readableHighWaterMark
11431153
<!-- YAML
11441154
added: v9.3.0
@@ -2781,6 +2791,7 @@ contain multi-byte characters.
27812791
[stream-read]: #stream_readable_read_size
27822792
[stream-resume]: #stream_readable_resume
27832793
[stream-write]: #stream_writable_write_chunk_encoding_callback
2794+
[Stream Three States]: #stream_three_states
27842795
[writable-_destroy]: #stream_writable_destroy_err_callback
27852796
[writable-destroy]: #stream_writable_destroy_error
27862797
[writable-new]: #stream_constructor_new_stream_writable_options

0 commit comments

Comments
 (0)