OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: update mode type for mkdir() functions

Browse Source 
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: https://github.com/nodejs/node/pull/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>
This commit is contained in:
cjihrig
2019-12-27 10:20:31 -05:00
committed by Rich Trott
parent 88f793536f
commit cbcee2d260
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/fs.md
View File

@@ -2459,7 +2459,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {Object|integer}
* `recursive` {boolean} **Default:** `false`
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
* `callback` {Function}
* `err` {Error}
@@ -2507,7 +2507,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {Object|integer}
* `recursive` {boolean} **Default:** `false`
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
Synchronously creates a directory. Returns `undefined`.
This is the synchronous version of [`fs.mkdir()`][].
@@ -4819,7 +4819,7 @@ added: v10.0.0
* `path` {string|Buffer|URL}
* `options` {Object|integer}
* `recursive` {boolean} **Default:** `false`
* `mode` {integer} Not supported on Windows. **Default:** `0o777`.
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
* Returns: {Promise}
Asynchronously creates a directory then resolves the `Promise` with no