diff options
| author | Luigi Pinca <luigipinca@gmail.com> | 2019-03-29 21:42:02 +0100 |
|---|---|---|
| committer | Daniel Bevenius <daniel.bevenius@gmail.com> | 2019-04-03 07:00:26 +0200 |
| commit | 98b5ba840e00cea1614266745fa0ccf1e6211315 (patch) | |
| tree | 0410cf3db719c61774d65ab4b30b6471a6126383 | |
| parent | 9e960175d101fd2b41765353feab2f67c750aa5c (diff) | |
| download | node-new-98b5ba840e00cea1614266745fa0ccf1e6211315.tar.gz | |
doc: document the 'pause' and 'resume' events
PR-URL: https://github.com/nodejs/node/pull/26999
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
| -rw-r--r-- | doc/api/stream.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index df171b9536..e4bb2fc379 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -799,6 +799,14 @@ to push an invalid chunk of data. The listener callback will be passed a single `Error` object. +##### Event: 'pause' +<!-- YAML +added: v0.9.4 +--> + +The `'pause'` event is emitted when [`stream.pause()`][stream-pause] is called +and `readableFlowing` is not `false`. + ##### Event: 'readable' <!-- YAML added: v0.9.4 @@ -868,6 +876,14 @@ If there are `'data'` listeners when `'readable'` is removed, the stream will start flowing, i.e. `'data'` events will be emitted without calling `.resume()`. +##### Event: 'resume' +<!-- YAML +added: v0.9.4 +--> + +The `'resume'` event is emitted when [`stream.resume()`][stream-resume] is +called and `readableFlowing` is not `true`. + ##### readable.destroy([error]) <!-- YAML added: v8.0.0 |