diff options
| author | Robert Nagy <ronagy@icloud.com> | 2021-11-02 13:01:48 +0300 |
|---|---|---|
| committer | Robert Nagy <ronagy@icloud.com> | 2021-11-13 12:19:32 +0300 |
| commit | f2170253b694c488f8ad2616dfc5c66b6a3c90a0 (patch) | |
| tree | cfc02c5681b04b339f719abf56f1fb1a60683056 /doc/api/stream.md | |
| parent | 3e5a5e8e1afcbf4c2d4a89f0359199d10da072a9 (diff) | |
stream: add errored and closed props
PR-URL: https://github.com/nodejs/node/pull/40696
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 44 |
1 files changed, 43 insertions, 1 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index f5be715cf1c..66436eff9cb 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -456,6 +456,16 @@ further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement [`writable._destroy()`][writable-_destroy]. +##### `writable.closed` + +<!-- YAML +added: REPLACEME +--> + +* {boolean} + +Is `true` after `'close'` has been emitted. + ##### `writable.destroyed` <!-- YAML @@ -611,6 +621,17 @@ added: Number of times [`writable.uncork()`][stream-uncork] needs to be called in order to fully uncork the stream. +##### `writable.writableErrored` + +<!-- YAML +added: + REPLACEME +--> + +* {Error} + +Returns error if the stream has been destroyed with an error. + ##### `writable.writableFinished` <!-- YAML @@ -1080,7 +1101,7 @@ further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement [`readable._destroy()`][readable-_destroy]. -##### `readable.destroyed` +##### `readable.closed` <!-- YAML added: v8.0.0 @@ -1088,6 +1109,16 @@ added: v8.0.0 * {boolean} +Is `true` after `'close'` has been emitted. + +##### `readable.destroyed` + +<!-- YAML +added: REPLACEME +--> + +* {boolean} + Is `true` after [`readable.destroy()`][readable-destroy] has been called. ##### `readable.isPaused()` @@ -1346,6 +1377,17 @@ added: v12.9.0 Becomes `true` when [`'end'`][] event is emitted. +##### `readable.readableErrored` + +<!-- YAML +added: + REPLACEME +--> + +* {Error} + +Returns error if the stream has been destroyed with an error. + ##### `readable.readableFlowing` <!-- YAML |