Commit cb75f56
doc: update mode type for mkdir() functions
This commit updates the documentation for fs.mkdir(),
fs.mkdirSync(), and fsPromises.mkdir() to reflect the fact
that their mode option can be a string.
PR-URL: #31115
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent cd310e1 commit cb75f56
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2433,7 +2433,7 @@ changes: | |||
| 2433 | 2433 | * `path` {string|Buffer|URL} | |
| 2434 | 2434 | * `options` {Object|integer} | |
| 2435 | 2435 | * `recursive` {boolean} **Default:** `false` | |
| 2436 | - * `mode` {integer} Not supported on Windows. **Default:** `0o777`. | ||
| 2436 | + * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 2437 | 2437 | * `callback` {Function} | |
| 2438 | 2438 | * `err` {Error} | |
| 2439 | 2439 | ||
@@ -2481,7 +2481,7 @@ changes: | |||
| 2481 | 2481 | * `path` {string|Buffer|URL} | |
| 2482 | 2482 | * `options` {Object|integer} | |
| 2483 | 2483 | * `recursive` {boolean} **Default:** `false` | |
| 2484 | - * `mode` {integer} Not supported on Windows. **Default:** `0o777`. | ||
| 2484 | + * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 2485 | 2485 | ||
| 2486 | 2486 | Synchronously creates a directory. Returns `undefined`. | |
| 2487 | 2487 | This is the synchronous version of [`fs.mkdir()`][]. | |
@@ -4793,7 +4793,7 @@ added: v10.0.0 | |||
| 4793 | 4793 | * `path` {string|Buffer|URL} | |
| 4794 | 4794 | * `options` {Object|integer} | |
| 4795 | 4795 | * `recursive` {boolean} **Default:** `false` | |
| 4796 | - * `mode` {integer} Not supported on Windows. **Default:** `0o777`. | ||
| 4796 | + * `mode` {string|integer} Not supported on Windows. **Default:** `0o777`. | ||
| 4797 | 4797 | * Returns: {Promise} | |
| 4798 | 4798 | ||
| 4799 | 4799 | Asynchronously creates a directory then resolves the `Promise` with no | |
0 commit comments