diff options
| author | domenic <domenic@domenicdenicola.com> | 2012-04-09 01:46:55 -0400 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2012-04-17 14:14:09 +0200 |
| commit | 5bc07cc90b4fb0a18704bc7b60e120b22fc78df7 (patch) | |
| tree | 0890a8d9f25550e9fefc3e4df6fd27b585049313 /doc | |
| parent | 70005be4ffdcfed0ac371873fa79a308ae4cc546 (diff) | |
| download | android-node-v8-5bc07cc90b4fb0a18704bc7b60e120b22fc78df7.tar.gz android-node-v8-5bc07cc90b4fb0a18704bc7b60e120b22fc78df7.tar.bz2 android-node-v8-5bc07cc90b4fb0a18704bc7b60e120b22fc78df7.zip | |
doc: note that `stream.pause` is advisory
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.markdown | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index aaf321977f..b380609dbe 100644 --- a/doc/api/stream.markdown +++ b/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() |