Commit a8fe6c3
doc: add File modes cross-references in fs methods
Adds links to the File modes section from fsPromises.open(),
fsPromises.mkdir(), and fs.mkdir() to improve discoverability
of file permission documentation.
PR-URL: #60286
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>1 parent 685259c commit a8fe6c3
1 file changed
Lines changed: 7 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1231,7 +1231,8 @@ added: v10.0.0 | |||
| 1231 | 1231 | * `path` {string|Buffer|URL} | |
| 1232 | 1232 | * `options` {Object|integer} | |
| 1233 | 1233 | * `recursive` {boolean} **Default:** `false` | |
| 1234 | - * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 1234 | + * `mode` {string|integer} Not supported on Windows. See [File modes][] | ||
| 1235 | + for more details. **Default:** `0o777`. | ||
| 1235 | 1236 | * Returns: {Promise} Upon success, fulfills with `undefined` if `recursive` | |
| 1236 | 1237 | is `false`, or the first directory path created if `recursive` is `true`. | |
| 1237 | 1238 | ||
@@ -1366,7 +1367,8 @@ changes: | |||
| 1366 | 1367 | * `flags` {string|number} See [support of file system `flags`][]. | |
| 1367 | 1368 | **Default:** `'r'`. | |
| 1368 | 1369 | * `mode` {string|integer} Sets the file mode (permission and sticky bits) | |
| 1369 | - if the file is created. **Default:** `0o666` (readable and writable) | ||
| 1370 | + if the file is created. See [File modes][] for more details. | ||
| 1371 | + **Default:** `0o666` (readable and writable) | ||
| 1370 | 1372 | * Returns: {Promise} Fulfills with a {FileHandle} object. | |
| 1371 | 1373 | ||
| 1372 | 1374 | Opens a {FileHandle}. | |
@@ -3454,7 +3456,8 @@ changes: | |||
| 3454 | 3456 | * `path` {string|Buffer|URL} | |
| 3455 | 3457 | * `options` {Object|integer} | |
| 3456 | 3458 | * `recursive` {boolean} **Default:** `false` | |
| 3457 | - * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 3459 | + * `mode` {string|integer} Not supported on Windows. See [File modes][] | ||
| 3460 | + for more details. **Default:** `0o777`. | ||
| 3458 | 3461 | * `callback` {Function} | |
| 3459 | 3462 | * `err` {Error} | |
| 3460 | 3463 | * `path` {string|undefined} Present only if a directory is created with | |
@@ -8697,6 +8700,7 @@ the file contents. | |||
| 8697 | 8700 | [Common System Errors]: errors.md#common-system-errors | |
| 8698 | 8701 | [FS constants]: #fs-constants | |
| 8699 | 8702 | [File access constants]: #file-access-constants | |
| 8703 | + [File modes]: #file-modes | ||
| 8700 | 8704 | [MDN-Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date | |
| 8701 | 8705 | [MDN-Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type | |
| 8702 | 8706 | [MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths | |
0 commit comments