diff options
author | Eugen Dueck <eugen@dueck.org> | 2012-07-31 13:15:46 +0900 |
---|---|---|
committer | Ben Noordhuis <info@bnoordhuis.nl> | 2012-08-01 01:45:09 +0200 |
commit | af699c47d1d333dab2eaf438ed78b504ebdb6b79 (patch) | |
tree | 1dd0c836a616f5d8ca58a08917ee68313a528897 /doc | |
parent | 2981f01b461fc69a25d3b7f0c23d32962dbc5ba7 (diff) | |
download | node-af699c47d1d333dab2eaf438ed78b504ebdb6b79.tar.gz |
doc: http: document res.write() `drain` return value
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/http.markdown | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/http.markdown b/doc/api/http.markdown index dbd31ac22..df4976115 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 |