Browse Source

doc: note that `stream.pause` is advisory

v0.9.1-release
domenic 13 years ago
committed by Ben Noordhuis
parent
commit
5bc07cc90b
  1. 8
      doc/api/stream.markdown

8
doc/api/stream.markdown

@ -57,7 +57,13 @@ Makes the data event emit a string instead of a `Buffer`. `encoding` can be
### stream.pause()
Pauses the incoming `'data'` events.
Issues an advisory signal to the underlying communication layer, requesting
that no further data be sent until `resume()` is called.
Note that, due to the advisory nature, certain streams will not be paused
immediately, and so `'data'` events may be emitted for some indeterminate
period of time even after `pause()` is called. You may wish to buffer such
`'data'` events.
### stream.resume()

Loading…
Cancel
Save