Skip to content

Commit 1fa8e49

Browse files
cjihrigBridgeAR
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 a37a88f commit 1fa8e49

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
@@ -2459,7 +2459,7 @@ changes:
24592459
* `path` {string|Buffer|URL}
24602460
* `options` {Object|integer}
24612461
* `recursive` {boolean} **Default:** `false`
2462-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
2462+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
24632463
* `callback` {Function}
24642464
* `err` {Error}
24652465

@@ -2507,7 +2507,7 @@ changes:
25072507
* `path` {string|Buffer|URL}
25082508
* `options` {Object|integer}
25092509
* `recursive` {boolean} **Default:** `false`
2510-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
2510+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
25112511

25122512
Synchronously creates a directory. Returns `undefined`.
25132513
This is the synchronous version of [`fs.mkdir()`][].
@@ -4819,7 +4819,7 @@ added: v10.0.0
48194819
* `path` {string|Buffer|URL}
48204820
* `options` {Object|integer}
48214821
* `recursive` {boolean} **Default:** `false`
4822-
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
4822+
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
48234823
* Returns: {Promise}
48244824

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

0 commit comments

Comments
 (0)