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

nodejs / node Public

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

• Code
• Issues 635
• Pull requests 756
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 3614d45

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored and

juanarbol

committed

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 41303d7 commit 3614d45
Copy full SHA for 3614d45

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

0 commit comments

Comments

0 (0)