Skip to content

Commit 51d1960

Browse files
saghulevanlucas
authored andcommitted
doc: undocument fs.open's 'rs' mode
Using O_SYNC with O_RDONLY is basically a noop. Closes: #6730 PR-URL: #6732 Reviewed-By: Ben Noorhduis <[email protected]>
1 parent abb063a commit 51d1960

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

doc/api/fs.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -748,8 +748,8 @@ An exception occurs if the file does not exist.
748748
* `'r+'` - Open file for reading and writing.
749749
An exception occurs if the file does not exist.
750750

751-
* `'rs'` - Open file for reading in synchronous mode. Instructs the operating
752-
system to bypass the local file system cache.
751+
* `'rs+'` - Open file for reading and writing in synchronous mode. Instructs
752+
the operating system to bypass the local file system cache.
753753

754754
This is primarily useful for opening files on NFS mounts as it allows you to
755755
skip the potentially stale local cache. It has a very real impact on I/O
@@ -758,9 +758,6 @@ An exception occurs if the file does not exist.
758758
Note that this doesn't turn `fs.open()` into a synchronous blocking call.
759759
If that's what you want then you should be using `fs.openSync()`
760760

761-
* `'rs+'` - Open file for reading and writing, telling the OS to open it
762-
synchronously. See notes for `'rs'` about using this with caution.
763-
764761
* `'w'` - Open file for writing.
765762
The file is created (if it does not exist) or truncated (if it exists).
766763

0 commit comments

Comments
 (0)