Skip to content

Commit 6b348d4

Browse files
陈刚gibfahn
陈刚
authored andcommittedApr 13, 2018
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>
1 parent dd4d075 commit 6b348d4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed
 

‎doc/api/http.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,9 @@ Defaults to `'utf8'`.
579579
The `callback` argument is optional and will be called when this chunk of data
580580
is flushed.
581581

582-
Returns `request`.
582+
Returns `true` if the entire data was flushed successfully to the kernel
583+
buffer. Returns `false` if all or part of the data was queued in user memory.
584+
`'drain'` will be emitted when the buffer is free again.
583585

584586
## Class: http.Server
585587
<!-- YAML

0 commit comments

Comments
 (0)