diff options
Diffstat (limited to 'doc/api/fs.md')
-rw-r--r-- | doc/api/fs.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index c369a579e2..d71f8afd82 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3863,6 +3863,52 @@ changes: For detailed information, see the documentation of the asynchronous version of this API: [`fs.write(fd, string...)`][]. +## fs.writev(fd, buffers[, position], callback) +<!-- YAML +added: REPLACEME +--> + +* `fd` {integer} +* `buffers` {ArrayBufferView[]} +* `position` {integer} +* `callback` {Function} + * `err` {Error} + * `bytesWritten` {integer} + * `buffers` {ArrayBufferView[]} + +Write an array of `ArrayBufferView`s to the file specified by `fd` using +`writev()`. + +`position` is the offset from the beginning of the file where this data +should be written. If `typeof position !== 'number'`, the data will be written +at the current position. + +The callback will be given three arguments: `err`, `bytesWritten`, and +`buffers`. `bytesWritten` is how many bytes were written from `buffers`. + +If this method is [`util.promisify()`][]ed, it returns a `Promise` for an +`Object` with `bytesWritten` and `buffers` properties. + +It is unsafe to use `fs.writev()` multiple times on the same file without +waiting for the callback. For this scenario, use [`fs.createWriteStream()`][]. + +On Linux, positional writes don't work when the file is opened in append mode. +The kernel ignores the position argument and always appends the data to +the end of the file. + +## fs.writevSync(fd, buffers[, position]) +<!-- YAML +added: REPLACEME +--> + +* `fd` {integer} +* `buffers` {ArrayBufferView[]} +* `position` {integer} +* Returns: {number} The number of bytes written. + +For detailed information, see the documentation of the asynchronous version of +this API: [`fs.writev()`][]. + ## fs Promises API The `fs.promises` API provides an alternative set of asynchronous file system @@ -5113,6 +5159,7 @@ the file contents. [`fs.write(fd, buffer...)`]: #fs_fs_write_fd_buffer_offset_length_position_callback [`fs.write(fd, string...)`]: #fs_fs_write_fd_string_position_encoding_callback [`fs.writeFile()`]: #fs_fs_writefile_file_data_options_callback +[`fs.writev()`]: #fs_fs_writev_fd_buffers_position_callback [`inotify(7)`]: http://man7.org/linux/man-pages/man7/inotify.7.html [`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 [`net.Socket`]: net.html#net_class_net_socket |