Skip to content

doc: add File modes cross-references in fs methods #60286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −3
Open

doc: add File modes cross-references in fs methods #60286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1231,7 +1231,8 @@ added: v10.0.0
* `path` {string|Buffer|URL}
* `options` {Object|integer}
* `recursive` {boolean} **Default:** `false`
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
* `mode` {string|integer} Not supported on Windows. See [File modes][]
for more details. **Default:** `0o777`.
* Returns: {Promise} Upon success, fulfills with `undefined` if `recursive`
is `false`, or the first directory path created if `recursive` is `true`.
Expand Down Expand Up @@ -1366,7 +1367,8 @@ changes:
* `flags` {string|number} See [support of file system `flags`][].
**Default:** `'r'`.
* `mode` {string|integer} Sets the file mode (permission and sticky bits)
if the file is created. **Default:** `0o666` (readable and writable)
if the file is created. See [File modes][] for more details.
**Default:** `0o666` (readable and writable)
* Returns: {Promise} Fulfills with a {FileHandle} object.
Opens a {FileHandle}.
Expand Down Expand Up @@ -3454,7 +3456,8 @@ changes:
* `path` {string|Buffer|URL}
* `options` {Object|integer}
* `recursive` {boolean} **Default:** `false`
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
* `mode` {string|integer} Not supported on Windows. See [File modes][]
for more details. **Default:** `0o777`.
* `callback` {Function}
* `err` {Error}
* `path` {string|undefined} Present only if a directory is created with
Expand Down Expand Up @@ -8715,6 +8718,7 @@ the file contents.
[`fs.access()`]: #fsaccesspath-mode-callback
[`fs.accessSync()`]: #fsaccesssyncpath-mode
[`fs.chmod()`]: #fschmodpath-mode-callback
[File modes]: #file-modes
[`fs.chown()`]: #fschownpath-uid-gid-callback
[`fs.copyFile()`]: #fscopyfilesrc-dest-mode-callback
[`fs.copyFileSync()`]: #fscopyfilesyncsrc-dest-mode
Expand Down
Loading