doc: note that `stream.pause` is advisory

pull/24503/head
domenic 2012-04-09 01:46:55 -04:00 committed by Ben Noordhuis
parent 70005be4ff
commit 5bc07cc90b
1 changed files with 7 additions and 1 deletions

View File

@ -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()