doc: document the 'pause' and 'resume' events

nodejs · Mar 30, 2019 · 7348b28 · 7348b28
1 parent 61ef9df
commit 7348b28
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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