Skip to content

Commit bd54abe

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 91f5e9b commit bd54abe

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/stream.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1886,8 +1886,8 @@ methods only.
18861886

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

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

0 commit comments

Comments
 (0)