diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-12-27 18:16:58 +0300 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2020-01-03 18:22:03 +0300 |
| commit | 2313b9e33b706ba556ca1131e5389fa59ce42f12 (patch) | |
| tree | 90c43513dbdbcf861eb8af8d3134e118edcb6ad6 /doc | |
| parent | 53c6a1ee34680790cccc2c0cf03e263e46b9dc7c (diff) | |
doc: update mode type for fs open() functions
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: 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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/fs.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 5c380a7022e..646d08a1133 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2627,7 +2627,7 @@ changes: * `path` {string|Buffer|URL} * `flags` {string|number} See [support of file system `flags`][]. **Default:** `'r'`. -* `mode` {integer} **Default:** `0o666` (readable and writable) +* `mode` {string|integer} **Default:** `0o666` (readable and writable) * `callback` {Function} * `err` {Error} * `fd` {integer} @@ -2719,7 +2719,7 @@ changes: * `path` {string|Buffer|URL} * `flags` {string|number} **Default:** `'r'`. See [support of file system `flags`][]. -* `mode` {integer} **Default:** `0o666` +* `mode` {string|integer} **Default:** `0o666` * Returns: {number} Returns an integer representing the file descriptor. @@ -4874,7 +4874,7 @@ changes: * `path` {string|Buffer|URL} * `flags` {string|number} See [support of file system `flags`][]. **Default:** `'r'`. -* `mode` {integer} **Default:** `0o666` (readable and writable) +* `mode` {string|integer} **Default:** `0o666` (readable and writable) * Returns: {Promise} Asynchronous file open that returns a `Promise` that, when resolved, yields a |