Skip to content

doc: update mode type for several functions #31115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

doc: update mode type for several functions #31115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08064f3
doc: update parameter type for fsPromises.chmod()
cjihrig Dec 27, 2019
0ab0c1a
doc: update mode type for fchmod() functions
cjihrig Dec 27, 2019
7ef5438
doc: update mode type for fs open() functions
cjihrig Dec 27, 2019
71443e2
doc: update mode type for process.umask()
cjihrig Dec 27, 2019
b30ae02
doc: update mode type for mkdir() functions
cjihrig Dec 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1979,7 +1979,7 @@ changes:
-->

* `fd` {integer}
* `mode` {integer}
* `mode` {string|integer}
* `callback` {Function}
* `err` {Error}

Expand All @@ -1992,7 +1992,7 @@ added: v0.4.7
-->

* `fd` {integer}
* `mode` {integer}
* `mode` {string|integer}

Synchronous fchmod(2). Returns `undefined`.

Expand Down Expand Up @@ -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}

Expand Down Expand Up @@ -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()`][].
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -4680,7 +4680,7 @@ added: v10.0.0
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {string|integer}
* Returns: {Promise}

Changes the permissions of a file then resolves the `Promise` with no
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2297,7 +2297,7 @@ flag's behavior.
added: v0.1.19
-->

* `mask` {number}
* `mask` {string|integer}

The `process.umask()` method sets or returns the Node.js process's file mode
creation mask. Child processes inherit the mask from the parent process. Invoked
Expand Down