doc: update mode type for several functions #31115

cjihrig · 2019-12-27T15:26:00Z

#31085 updated the documented type for the mode argument to fs.chmod() and fs.chmodSync(), but it missed fsPromises.chmod(). Furthermore, the fchmod(), open(), mkdir(), and process.umask() require similar updates. This PR provides those updates.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

This was overlooked in nodejs#31085.

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this.

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() to reflect the fact that their mode option can be a string.

This commit updates the documentation for process.umask() to reflect the fact that the mode option can be a string.

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.

Trott · 2019-12-29T15:32:44Z

Landed in c6822be...cbcee2d

This was overlooked in #31085. 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]>

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this. 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]>

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() 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]>

This commit updates the documentation for process.umask() to reflect the fact that the 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]>

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]>

This was overlooked in #31085. 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]>

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this. 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]>

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() 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]>

This commit updates the documentation for process.umask() to reflect the fact that the 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]>

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]>

This was overlooked in #31085. 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]>

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this. 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]>

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() 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]>

This commit updates the documentation for process.umask() to reflect the fact that the 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]>

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]>

This was overlooked in #31085. 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]>

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this. 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]>

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() 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]>

This commit updates the documentation for process.umask() to reflect the fact that the 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]>

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]>

cjihrig added 5 commits December 27, 2019 10:09

doc: update parameter type for fsPromises.chmod()

08064f3

This was overlooked in nodejs#31085.

doc: update mode type for fchmod() functions

0ab0c1a

fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this.

doc: update mode type for fs open() functions

7ef5438

This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() to reflect the fact that their mode option can be a string.

doc: update mode type for process.umask()

71443e2

This commit updates the documentation for process.umask() to reflect the fact that the mode option can be a string.

doc: update mode type for mkdir() functions

b30ae02

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.

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 27, 2019

BridgeAR approved these changes Dec 27, 2019

View reviewed changes

Trott approved these changes Dec 27, 2019

View reviewed changes

Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 27, 2019

devnexen approved these changes Dec 27, 2019

View reviewed changes

lpinca approved these changes Dec 27, 2019

View reviewed changes

Trott closed this Dec 29, 2019

cjihrig deleted the doc branch December 29, 2019 15:36

BridgeAR mentioned this pull request Jan 7, 2020

v13.6.0 proposal #31238

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: update mode type for several functions #31115

doc: update mode type for several functions #31115

cjihrig commented Dec 27, 2019

Trott commented Dec 29, 2019

doc: update mode type for several functions #31115

doc: update mode type for several functions #31115

Conversation

cjihrig commented Dec 27, 2019

Checklist

Trott commented Dec 29, 2019