Skip to content

Commit cb75f56

Browse files
cjihrigtargos
authored andcommitted
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 <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent cd310e1 commit cb75f56

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/fs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2433,7 +2433,7 @@ changes:
24332433
* `path` {string|Buffer|URL}
24342434
* `options` {Object|integer}
24352435
* `recursive` {boolean} **Default:** `false`
2436-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
2436+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
24372437
* `callback` {Function}
24382438
* `err` {Error}
24392439

@@ -2481,7 +2481,7 @@ changes:
24812481
* `path` {string|Buffer|URL}
24822482
* `options` {Object|integer}
24832483
* `recursive` {boolean} **Default:** `false`
2484-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
2484+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
24852485

24862486
Synchronously creates a directory. Returns `undefined`.
24872487
This is the synchronous version of [`fs.mkdir()`][].
@@ -4793,7 +4793,7 @@ added: v10.0.0
47934793
* `path` {string|Buffer|URL}
47944794
* `options` {Object|integer}
47954795
* `recursive` {boolean} **Default:** `false`
4796-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
4796+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
47974797
* Returns: {Promise}
47984798

47994799
Asynchronously creates a directory then resolves the `Promise` with no

0 commit comments

Comments
 (0)