doc: recommend `fh.createWriteStream` for fsPromises methods · nodejs/node@a82713c · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 638
• Pull requests 759
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit a82713c

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored

doc: recommend fh.createWriteStream for fsPromises methods

`fh.createWriteStream` can be more convenient than `fs.createWriteStream` when using the FS promises API. PR-URL: #42653 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>

1 parent 6d4b017 commit a82713c
Copy full SHA for a82713c

1 file changed

+4-3Lines changed: 4 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • fs.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md

+4-3Lines changed: 4 additions & 3 deletions

• Display the source diff
• Display the rich diff

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

0 commit comments

Comments

0 (0)