From 7eb73d301d0d99c2d20dd2f2c25bf5eddf7cd9b0 Mon Sep 17 00:00:00 2001
From: Luigi Pinca <luigipinca@gmail.com>
Date: Fri, 29 Mar 2019 21:42:02 +0100
Subject: [PATCH] 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>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
---
 doc/api/stream.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index 156f09f374c5bf..66627abf6a9b8d 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