Skip to content
Browse files

doc: http: document res.write() `drain` return value

  • Loading branch information...
1 parent 2981f01 commit af699c47d1d333dab2eaf438ed78b504ebdb6b79 @EugenDueck EugenDueck committed with bnoordhuis Jul 31, 2012
Showing with 4 additions and 0 deletions.
  1. +4 −0 doc/api/http.markdown
View
4 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

0 comments on commit af699c4

Please sign in to comment.
Something went wrong with that request. Please try again.