Skip to content

Commit

Permalink
doc: add documentation for stream readableFlowing
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ckarande authored and BethGriggs committed Oct 17, 2019
1 parent d6c998a commit 65e68d1
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 65e68d1

Please sign in to comment.