Skip to content

Commit ff8f0bc

Browse files
HarshithaKPcodebytere
authored andcommitted
doc: explain _writev() API
The exact context of invocation of _writev API is not well known. Also, the choice between _write and _writev is not well known. Add a description to make it explicit. Fixes: #28408 Refs: #28690 Co-authored-by: Parker Bjur <[email protected]> PR-URL: #31356 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent b4d15a9 commit ff8f0bc

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/stream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1882,8 +1882,8 @@ methods only.
18821882

18831883
The `writable._writev()` method may be implemented in addition or alternatively
18841884
to `writable._write()` in stream implementations that are capable of processing
1885-
multiple chunks of data at once. If implemented, the method will be called with
1886-
all chunks of data currently buffered in the write queue.
1885+
multiple chunks of data at once. If implemented and if there is buffered data
1886+
from previous writes, `_writev()` will be called instead of `_write()`.
18871887

18881888
The `writable._writev()` method is prefixed with an underscore because it is
18891889
internal to the class that defines it, and should never be called directly by

0 commit comments

Comments
 (0)