diff options
| author | Robert Nagy <ronagy@icloud.com> | 2021-12-16 16:32:02 +0300 |
|---|---|---|
| committer | Robert Nagy <ronagy@icloud.com> | 2021-12-29 22:42:10 +0300 |
| commit | a698c49993050491c00d1127236d714c9e8ce2eb (patch) | |
| tree | d937d4065c404312ddfd349d41eb43d2d158ebf6 /doc/api/stream.md | |
| parent | b97b81d4ec674437f49931268c328703683125ee (diff) | |
stream: add isReadable helper
PR-URL: https://github.com/nodejs/node/pull/41199
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index ab285301e1a..6280fc74045 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -2282,6 +2282,19 @@ added: v17.3.0 Returns whether the stream has encountered an error. +### `stream.isReadable(stream)` + +<!-- YAML +added: REPLACEME +--> + +> Stability: 1 - Experimental + +* `stream` {Readable|Duplex|ReadableStream} +* Returns: {boolean} + +Returns whether the stream is readable. + ### `stream.Readable.toWeb(streamReadable)` <!-- YAML |