OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

doc: clarify descriptions of _writev chunks argument

Browse Source 
Fixes: https://github.com/nodejs/node/issues/36789
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/36822
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
This commit is contained in:
James M Snell
2021-01-06 13:59:32 -08:00
parent 3af175fb5e
commit 96c3498710
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/stream.md
View File

@@ -2162,8 +2162,14 @@ user programs.
#### `writable._writev(chunks, callback)`
* `chunks` {Object[]} The chunks to be written. Each chunk has following
format: `{ chunk: ..., encoding: ... }`.
* `chunks` {Object[]} The data to be written. The value is an array of {Object}
that each represent a discreet chunk of data to write. The properties of
these objects are:
* `chunk` {Buffer|string} A buffer instance or string containing the data to
be written. The `chunk` will be a string if the `Writable` was created with
the `decodeStrings` option set to `false` and a string was passed to `write()`.
* `encoding` {string} The character encoding of the `chunk`. If `chunk` is
a `Buffer`, the `encoding` will be `'buffer`.
* `callback` {Function} A callback function (optionally with an error
argument) to be invoked when processing is complete for the supplied chunks.