summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author陈刚 <chengang07@meituan.com>2018-02-02 18:40:01 +0800
committerRuben Bridgewater <ruben@bridgewater.de>2018-02-06 13:54:16 +0100
commit766eea6ca48d5ca5cd2e9a1442a9dd6fc4932d9d (patch)
treecdb6f275b0462860e361514f5351eda323658691
parent6a29630c30186d7a0c71203fe7b15a39ea080c1d (diff)
downloadandroid-node-v8-766eea6ca48d5ca5cd2e9a1442a9dd6fc4932d9d.tar.gz
android-node-v8-766eea6ca48d5ca5cd2e9a1442a9dd6fc4932d9d.tar.bz2
android-node-v8-766eea6ca48d5ca5cd2e9a1442a9dd6fc4932d9d.zip
doc: modify the return value of request.write()
PR-URL: https://github.com/nodejs/node/pull/18526 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
-rw-r--r--doc/api/http.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/http.md b/doc/api/http.md
index 65d07ced0f..fadb5054e2 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -681,7 +681,9 @@ Defaults to `'utf8'`.
The `callback` argument is optional and will be called when this chunk of data
is flushed.
-Returns `request`.
+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 free again.
## Class: http.Server
<!-- YAML