Commit 0c83169
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 311a04c commit 0c83169
1 file changed
Lines changed: 7 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1227,7 +1227,8 @@ added: v10.0.0 | |||
| 1227 | 1227 | * `path` {string|Buffer|URL} | |
| 1228 | 1228 | * `options` {Object|integer} | |
| 1229 | 1229 | * `recursive` {boolean} **Default:** `false` | |
| 1230 | - * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 1230 | + * `mode` {string|integer} Not supported on Windows. See [File modes][] | ||
| 1231 | + for more details. **Default:** `0o777`. | ||
| 1231 | 1232 | * Returns: {Promise} Upon success, fulfills with `undefined` if `recursive` | |
| 1232 | 1233 | is `false`, or the first directory path created if `recursive` is `true`. | |
| 1233 | 1234 | ||
@@ -1362,7 +1363,8 @@ changes: | |||
| 1362 | 1363 | * `flags` {string|number} See [support of file system `flags`][]. | |
| 1363 | 1364 | **Default:** `'r'`. | |
| 1364 | 1365 | * `mode` {string|integer} Sets the file mode (permission and sticky bits) | |
| 1365 | - if the file is created. **Default:** `0o666` (readable and writable) | ||
| 1366 | + if the file is created. See [File modes][] for more details. | ||
| 1367 | + **Default:** `0o666` (readable and writable) | ||
| 1366 | 1368 | * Returns: {Promise} Fulfills with a {FileHandle} object. | |
| 1367 | 1369 | ||
| 1368 | 1370 | Opens a {FileHandle}. | |
@@ -3447,7 +3449,8 @@ changes: | |||
| 3447 | 3449 | * `path` {string|Buffer|URL} | |
| 3448 | 3450 | * `options` {Object|integer} | |
| 3449 | 3451 | * `recursive` {boolean} **Default:** `false` | |
| 3450 | - * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 3452 | + * `mode` {string|integer} Not supported on Windows. See [File modes][] | ||
| 3453 | + for more details. **Default:** `0o777`. | ||
| 3451 | 3454 | * `callback` {Function} | |
| 3452 | 3455 | * `err` {Error} | |
| 3453 | 3456 | * `path` {string|undefined} Present only if a directory is created with | |
@@ -8688,6 +8691,7 @@ the file contents. | |||
| 8688 | 8691 | [Common System Errors]: errors.md#common-system-errors | |
| 8689 | 8692 | [FS constants]: #fs-constants | |
| 8690 | 8693 | [File access constants]: #file-access-constants | |
| 8694 | + [File modes]: #file-modes | ||
| 8691 | 8695 | [MDN-Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date | |
| 8692 | 8696 | [MDN-Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type | |
| 8693 | 8697 | [MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths | |
0 commit comments