doc: modify the return value of request.write()

PR-URL: #18526 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · Feb 21, 2018 · c18d9587502701dd2fd0bfe5bbdeba4654edc3a6 · c18d958
1 parent 3ec3c32
commit c18d9587502701dd2fd0bfe5bbdeba4654edc3a6
Showing with 3 additions and 1 deletion.

+3 −1 doc/api/http.md
diff --git 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