1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add documentation for stream readableFlowing

Browse Source 
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>
This commit is contained in:
Chetan Karande 2019-09-09 11:57:14 -04:00 committed by Rich Trott
parent df0e2e3625
commit 7b32654ab9
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/stream.md
View File

@ -1139,6 +1139,16 @@ added: v12.9.0
Becomes `true` when [`'end'`][] event is emitted. Becomes `true` when [`'end'`][] event is emitted.
##### 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 ##### readable.readableHighWaterMark
<!-- YAML <!-- YAML
added: v9.3.0 added: v9.3.0
@ -2781,6 +2791,7 @@ contain multi-byte characters.
[stream-read]: #stream_readable_read_size [stream-read]: #stream_readable_read_size
[stream-resume]: #stream_readable_resume [stream-resume]: #stream_readable_resume
[stream-write]: #stream_writable_write_chunk_encoding_callback [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_err_callback
[writable-destroy]: #stream_writable_destroy_error [writable-destroy]: #stream_writable_destroy_error
[writable-new]: #stream_constructor_new_stream_writable_options [writable-new]: #stream_constructor_new_stream_writable_options