Skip to content

Commit 65e68d1

Browse files
ckarandeBethGriggs
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 d6c998a commit 65e68d1

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
@@ -1047,6 +1047,16 @@ added: v0.8.0
10471047

10481048
Is `true` if it is safe to call [`readable.read()`][].
10491049

1050+
##### readable.readableFlowing
1051+
<!-- YAML
1052+
added: v9.4.0
1053+
-->
1054+
1055+
* {boolean}
1056+
1057+
This property reflects the current state of a `Readable` stream as described
1058+
in the [Stream Three States][] section.
1059+
10501060
##### readable.readableHighWaterMark
10511061
<!-- YAML
10521062
added: v9.3.0
@@ -2638,6 +2648,7 @@ contain multi-byte characters.
26382648
[stream-read]: #stream_readable_read_size
26392649
[stream-resume]: #stream_readable_resume
26402650
[stream-write]: #stream_writable_write_chunk_encoding_callback
2651+
[Stream Three States]: #stream_three_states
26412652
[writable-_destroy]: #stream_writable_destroy_err_callback
26422653
[writable-destroy]: #stream_writable_destroy_error
26432654
[zlib]: zlib.html

0 commit comments

Comments
 (0)