diff options
| author | Chetan Karande <kchetan.tech@gmail.com> | 2019-09-09 18:57:14 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2019-10-18 01:47:20 +0300 |
| commit | 65e68d1f4f9572324b7c6dcf9d9d384fcfa6f5bf (patch) | |
| tree | 81cf8a870437ef83ff4b09fe3f2b4554d567ea9c | |
| parent | d6c998a478cd7ca9329d5410f23a9d8a7b8e8d5e (diff) | |
doc: add documentation for stream readableFlowing
PR-URL: https://github.com/nodejs/node/pull/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>
| -rw-r--r-- | doc/api/stream.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 24f3ee8900f..ee3202e0a7b 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1047,6 +1047,16 @@ added: v0.8.0 Is `true` if it is safe to call [`readable.read()`][]. +##### 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 @@ -2638,6 +2648,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 [zlib]: zlib.html |