Skip to content

Commit 7eb73d3

Browse files
lpincaBethGriggs
authored andcommitted
doc: document the 'pause' and 'resume' events
PR-URL: #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>
1 parent 57ced2d commit 7eb73d3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/api/stream.md

+16
Original file line numberDiff line numberDiff line change
@@ -799,6 +799,14 @@ to push an invalid chunk of data.
799799

800800
The listener callback will be passed a single `Error` object.
801801

802+
##### Event: 'pause'
803+
<!-- YAML
804+
added: v0.9.4
805+
-->
806+
807+
The `'pause'` event is emitted when [`stream.pause()`][stream-pause] is called
808+
and `readableFlowing` is not `false`.
809+
802810
##### Event: 'readable'
803811
<!-- YAML
804812
added: v0.9.4
@@ -868,6 +876,14 @@ If there are `'data'` listeners when `'readable'` is removed, the stream
868876
will start flowing, i.e. `'data'` events will be emitted without calling
869877
`.resume()`.
870878

879+
##### Event: 'resume'
880+
<!-- YAML
881+
added: v0.9.4
882+
-->
883+
884+
The `'resume'` event is emitted when [`stream.resume()`][stream-resume] is
885+
called and `readableFlowing` is not `true`.
886+
871887
##### readable.destroy([error])
872888
<!-- YAML
873889
added: v8.0.0

0 commit comments

Comments
 (0)