1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add filehandle.write(string[, position[, encoding]])

Browse Source 
Add missing docs for filehandle.write(string[, position[, encoding]])
In the fs.promises API.

Fixes: https://github.com/nodejs/node/issues/20406
PR-URL: https://github.com/nodejs/node/pull/23224
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
This commit is contained in:
Dara Hayes 2018-11-13 16:28:07 +00:00 committed by Rich Trott
parent 67b67ad050
commit 692b09ffbe
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/api/fs.md
View File

@ -3968,6 +3968,37 @@ On Linux, positional writes do not 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.
#### filehandle.write(string[, position[, encoding]])
<!-- YAML
added: v10.0.0
-->
* `string` {string}
* `position` {integer}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {Promise}
Write `string` to the file. If `string` is not a string, then
the value will be coerced to one.
The `Promise` is resolved with an object containing a `bytesWritten` property
identifying the number of bytes written, and a `buffer` property containing
a reference to the `string` written.
`position` refers to the offset from the beginning of the file where this data
should be written. If the type of `position` is not a `number` the data
will be written at the current position. See pwrite(2).
`encoding` is the expected string encoding.
It is unsafe to use `filehandle.write()` multiple times on the same file
without waiting for the `Promise` to be resolved (or rejected). For this
scenario, [`fs.createWriteStream()`][] is strongly recommended.
On Linux, positional writes do not 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.
#### filehandle.writeFile(data, options)
<!-- YAML
added: v10.0.0