Skip to content

Commit 1ea1970

Browse files
陈刚gibfahn
陈刚
authored andcommitted
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 d4bcccc commit 1ea1970

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
@@ -681,7 +681,9 @@ Defaults to `'utf8'`.
681681
The `callback` argument is optional and will be called when this chunk of data
682682
is flushed.
683683

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

686688
## Class: http.Server
687689
<!-- YAML

0 commit comments

Comments
 (0)