1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improve fs api descriptions

Browse Source 
This improves the api descriptions for fs.chown, fs.chmod, and fs.mkdir
along with their *Sync counterparts.

PR-URL: https://github.com/nodejs/node/pull/17679
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Evan Lucas 2017-12-14 05:56:38 -06:00 committed by Jon Moss
parent 7352bf2f7c
commit 35511c8ba1
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/api/fs.md
View File

@ -891,8 +891,10 @@ changes:
* `callback` {Function}
* `err` {Error}
Asynchronous chmod(2). No arguments other than a possible exception are given
to the completion callback.
Asynchronously changes the permissions of a file. No arguments other than a
possible exception are given to the completion callback.
See also: chmod(2)
## fs.chmodSync(path, mode)
<!-- YAML
@ -907,7 +909,10 @@ changes:
* `path` {string|Buffer|URL}
* `mode` {integer}
Synchronous chmod(2). Returns `undefined`.
Synchronously changes the permissions of a file. Returns `undefined`.
This is the synchronous version of [`fs.chmod()`][].
See also: chmod(2)
## fs.chown(path, uid, gid, callback)
<!-- YAML
@ -929,8 +934,10 @@ changes:
* `callback` {Function}
* `err` {Error}
Asynchronous chown(2). No arguments other than a possible exception are given
to the completion callback.
Asynchronously changes owner and group of a file. No arguments other than a
possible exception are given to the completion callback.
See also: chown(2)
## fs.chownSync(path, uid, gid)
<!-- YAML
@ -946,7 +953,10 @@ changes:
* `uid` {integer}
* `gid` {integer}
Synchronous chown(2). Returns `undefined`.
Synchronously changes owner and group of a file. Returns `undefined`.
This is the synchronous version of [`fs.chown()`][].
See also: chown(2)
## fs.close(fd, callback)
<!-- YAML
@ -1733,8 +1743,10 @@ changes:
* `callback` {Function}
* `err` {Error}
Asynchronous mkdir(2). No arguments other than a possible exception are given
to the completion callback. `mode` defaults to `0o777`.
Asynchronously creates a directory. No arguments other than a possible exception
are given to the completion callback. `mode` defaults to `0o777`.
See also: mkdir(2)
## fs.mkdirSync(path[, mode])
<!-- YAML
@ -1749,7 +1761,10 @@ changes:
* `path` {string|Buffer|URL}
* `mode` {integer} **Default:** `0o777`
Synchronous mkdir(2). Returns `undefined`.
Synchronously creates a directory. Returns `undefined`.
This is the synchronous version of [`fs.mkdir()`][].
See also: mkdir(2)
## fs.mkdtemp(prefix[, options], callback)
<!-- YAML
@ -3331,10 +3346,13 @@ The following constants are meant for use with the [`fs.Stats`][] object's
[`fs.Stats`]: #fs_class_fs_stats
[`fs.access()`]: #fs_fs_access_path_mode_callback
[`fs.appendFile()`]: fs.html#fs_fs_appendfile_file_data_options_callback
[`fs.chmod()`]: #fs_fs_chmod_path_mode_callback
[`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
[`fs.exists()`]: fs.html#fs_fs_exists_path_callback
[`fs.fstat()`]: #fs_fs_fstat_fd_callback
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
[`fs.lstat()`]: #fs_fs_lstat_path_callback
[`fs.mkdir()`]: #fs_fs_mkdir_path_mode_callback
[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_options_callback
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback