Commit 3aea277
doc: add documentation for stream readableFlowing
PR-URL: #29506
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent f5f238d commit 3aea277
1 file changed
Lines changed: 11 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1136,6 +1136,16 @@ added: v12.9.0 | |||
| 1136 | 1136 | ||
| 1137 | 1137 | Becomes `true` when [`'end'`][] event is emitted. | |
| 1138 | 1138 | ||
| 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 | + | ||
| 1139 | 1149 | ##### readable.readableHighWaterMark | |
| 1140 | 1150 | <!-- YAML | |
| 1141 | 1151 | added: v9.3.0 | |
@@ -2778,6 +2788,7 @@ contain multi-byte characters. | |||
| 2778 | 2788 | [stream-read]: #stream_readable_read_size | |
| 2779 | 2789 | [stream-resume]: #stream_readable_resume | |
| 2780 | 2790 | [stream-write]: #stream_writable_write_chunk_encoding_callback | |
| 2791 | + [Stream Three States]: #stream_three_states | ||
| 2781 | 2792 | [writable-_destroy]: #stream_writable_destroy_err_callback | |
| 2782 | 2793 | [writable-destroy]: #stream_writable_destroy_error | |
| 2783 | 2794 | [writable-new]: #stream_constructor_new_stream_writable_options | |
0 commit comments