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

doc: recommend fh.createWriteStream for fsPromises methods

Browse Source 
`fh.createWriteStream` can be more convenient than
`fs.createWriteStream` when using the FS promises API.

PR-URL: https://github.com/nodejs/node/pull/42653
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
This commit is contained in:
Antoine du Hamel 2022-04-10 13:35:08 +02:00 committed by GitHub
parent 6d4b01774b
commit a82713cbb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/fs.md
View File

@ -613,7 +613,7 @@ The promise is resolved with an object containing two properties:
It is unsafe to use `filehandle.write()` multiple times on the same file 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 without waiting for the promise to be resolved (or rejected). For this
scenario, use [`fs.createWriteStream()`][]. scenario, use [`filehandle.createWriteStream()`][].
On Linux, positional writes do not work when the file is opened in append mode. 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 kernel ignores the position argument and always appends the data to
@ -648,7 +648,7 @@ The promise is resolved with an object containing two properties:
It is unsafe to use `filehandle.write()` multiple times on the same file 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 without waiting for the promise to be resolved (or rejected). For this
scenario, use [`fs.createWriteStream()`][]. scenario, use [`filehandle.createWriteStream()`][].
On Linux, positional writes do not work when the file is opened in append mode. 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 kernel ignores the position argument and always appends the data to
@ -1547,7 +1547,7 @@ without waiting for the promise to be settled.
Similarly to `fsPromises.readFile` - `fsPromises.writeFile` is a convenience Similarly to `fsPromises.readFile` - `fsPromises.writeFile` is a convenience
method that performs multiple `write` calls internally to write the buffer method that performs multiple `write` calls internally to write the buffer
passed to it. For performance sensitive code consider using passed to it. For performance sensitive code consider using
[`fs.createWriteStream()`][]. [`fs.createWriteStream()`][] or [`filehandle.createWriteStream()`][].
It is possible to use an {AbortSignal} to cancel an `fsPromises.writeFile()`. It is possible to use an {AbortSignal} to cancel an `fsPromises.writeFile()`.
Cancelation is "best effort", and some amount of data is likely still Cancelation is "best effort", and some amount of data is likely still
@ -7471,6 +7471,7 @@ the file contents.
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw [`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize [`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
[`event ports`]: https://illumos.org/man/port_create [`event ports`]: https://illumos.org/man/port_create
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
[`filehandle.writeFile()`]: #filehandlewritefiledata-options [`filehandle.writeFile()`]: #filehandlewritefiledata-options
[`fs.access()`]: #fsaccesspath-mode-callback [`fs.access()`]: #fsaccesspath-mode-callback
[`fs.accessSync()`]: #fsaccesssyncpath-mode [`fs.accessSync()`]: #fsaccesssyncpath-mode