From 7348b28aff423e1891a7bf41b7efc5e114b87cf7 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Fri, 29 Mar 2019 21:42:02 +0100 Subject: [PATCH] doc: document the 'pause' and 'resume' events --- doc/api/stream.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/api/stream.md b/doc/api/stream.md index df171b95369741..e4bb2fc379c2db 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' + + +The `'pause'` event is emitted when [`stream.pause()`][stream-pause] is called +and `readableFlowing` is not `false`. + ##### Event: 'readable' + +The `'resume'` event is emitted when [`stream.resume()`][stream-resume] is +called and `readableFlowing` is not `true`. + ##### readable.destroy([error])