From 5bc07cc90b4fb0a18704bc7b60e120b22fc78df7 Mon Sep 17 00:00:00 2001 From: domenic Date: Mon, 9 Apr 2012 01:46:55 -0400 Subject: [PATCH] doc: note that `stream.pause` is advisory --- doc/api/stream.markdown | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index aaf3219..b380609 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() -- 2.7.4