From af699c47d1d333dab2eaf438ed78b504ebdb6b79 Mon Sep 17 00:00:00 2001 From: Eugen Dueck Date: Tue, 31 Jul 2012 13:15:46 +0900 Subject: [PATCH] doc: http: document res.write() `drain` return value --- doc/api/http.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/http.markdown b/doc/api/http.markdown index dbd31ac221..df4976115c 100644 --- a/doc/api/http.markdown +++ b/doc/api/http.markdown @@ -426,6 +426,10 @@ header information and the first body to the client. The second time data, and sends that separately. That is, the response is buffered up to the first chunk of body. +Returns `true` if the entire data was flushed successfully to the kernel +buffer. Returns `false` if all or part of the data was queued in user memory. +`'drain'` will be emitted when the buffer is again free. + ### response.addTrailers(headers) This method adds HTTP trailing headers (a header but at the end of the