Skip to content

Commit 2313b9e

Browse files
cjihrigBridgeAR
authored andcommittedJan 3, 2020
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: #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 53c6a1e commit 2313b9e

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
@@ -2627,7 +2627,7 @@ changes:
26272627
* `path` {string|Buffer|URL}
26282628
* `flags` {string|number} See [support of file system `flags`][].
26292629
**Default:** `'r'`.
2630-
* `mode` {integer} **Default:** `0o666` (readable and writable)
2630+
* `mode` {string|integer} **Default:** `0o666` (readable and writable)
26312631
* `callback` {Function}
26322632
* `err` {Error}
26332633
* `fd` {integer}
@@ -2719,7 +2719,7 @@ changes:
27192719
* `path` {string|Buffer|URL}
27202720
* `flags` {string|number} **Default:** `'r'`.
27212721
See [support of file system `flags`][].
2722-
* `mode` {integer} **Default:** `0o666`
2722+
* `mode` {string|integer} **Default:** `0o666`
27232723
* Returns: {number}
27242724

27252725
Returns an integer representing the file descriptor.
@@ -4874,7 +4874,7 @@ changes:
48744874
* `path` {string|Buffer|URL}
48754875
* `flags` {string|number} See [support of file system `flags`][].
48764876
**Default:** `'r'`.
4877-
* `mode` {integer} **Default:** `0o666` (readable and writable)
4877+
* `mode` {string|integer} **Default:** `0o666` (readable and writable)
48784878
* Returns: {Promise}
48794879

48804880
Asynchronous file open that returns a `Promise` that, when resolved, yields a

0 commit comments

Comments
 (0)
Please sign in to comment.