Skip to content
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

doc: add default values to function signatures in fs.md #13767

Closed
wants to merge 2 commits into from
Closed

doc: add default values to function signatures in fs.md #13767

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a12748
doc: add default values to function signatures in fs.md
matejkrajcovic Jun 18, 2017
0cfdbde
doc: update fs.md to new default values style
matejkrajcovic Jun 19, 2017
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
96 changes: 48 additions & 48 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {integer} **Default:** `fs.constants.F_OK`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to get consistency here but I would prefer something like:

Defaults to `fs.constants.F_OK`

Without the bold styling.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasnell seems like an issue for #13769, which I had thought you were okay with.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, in general I'm good with improved consistency and won't block this, I just don't prefer the bold styling.

* `callback` {Function}

Tests a user's permissions for the file or directory specified by `path`.
Expand Down Expand Up @@ -562,7 +562,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {integer} **Default:** `fs.constants.F_OK`

Synchronous version of [`fs.access()`][]. This throws if any accessibility
checks fail, and does nothing otherwise.
Expand All @@ -586,9 +586,9 @@ changes:
* `file` {string|Buffer|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} default = `'utf8'`
* `mode` {integer} default = `0o666`
* `flag` {string} default = `'a'`
* `encoding` {string|null} **Default:** `'utf8'`
* `mode` {integer} **Default:** `0o666`
* `flag` {string} **Default:** `'a'`
* `callback` {Function}

Asynchronously append data to a file, creating the file if it does not yet exist.
Expand Down Expand Up @@ -629,9 +629,9 @@ changes:
* `file` {string|Buffer|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} default = `'utf8'`
* `mode` {integer} default = `0o666`
* `flag` {string} default = `'a'`
* `encoding` {string|null} **Default:** `'utf8'`
* `mode` {integer} **Default:** `0o666`
* `flag` {string} **Default:** `'a'`

The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.

Expand Down Expand Up @@ -1135,7 +1135,7 @@ added: v0.1.96

Synchronous fsync(2). Returns `undefined`.

## fs.ftruncate(fd, len, callback)
## fs.ftruncate(fd[, len], callback)
<!-- YAML
added: v0.8.6
changes:
Expand All @@ -1146,7 +1146,7 @@ changes:
-->

* `fd` {integer}
* `len` {integer} default = `0`
* `len` {integer} **Default:** `0`
* `callback` {Function}

Asynchronous ftruncate(2). No arguments other than a possible exception are
Expand Down Expand Up @@ -1193,13 +1193,13 @@ fs.ftruncate(fd, 10, (err) => {

The last three bytes are null bytes ('\0'), to compensate the over-truncation.

## fs.ftruncateSync(fd, len)
## fs.ftruncateSync(fd[, len])
<!-- YAML
added: v0.8.6
-->

* `fd` {integer}
* `len` {integer} default = `0`
* `len` {integer} **Default:** `0`

Synchronous ftruncate(2). Returns `undefined`.

Expand Down Expand Up @@ -1388,7 +1388,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {integer} **Default:** `0o777`
* `callback` {Function}

Asynchronous mkdir(2). No arguments other than a possible exception are given
Expand All @@ -1405,7 +1405,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {integer} **Default:** `0o777`

Synchronous mkdir(2). Returns `undefined`.

Expand All @@ -1424,7 +1424,7 @@ changes:

* `prefix` {string}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`
* `callback` {Function}

Creates a unique temporary directory.
Expand Down Expand Up @@ -1486,7 +1486,7 @@ added: v5.10.0

* `prefix` {string}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`

The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path.
Expand All @@ -1506,7 +1506,7 @@ changes:

* `path` {string|Buffer|URL}
* `flags` {string|number}
* `mode` {integer}
* `mode` {integer} **Default:** `0o666`
* `callback` {Function}

Asynchronous file open. See open(2). `flags` can be:
Expand Down Expand Up @@ -1548,7 +1548,7 @@ The file is created if it does not exist.
* `'ax+'` - Like `'a+'` but fails if `path` exists.

`mode` sets the file mode (permission and sticky bits), but only if the file was
created. It defaults to `0666`, readable and writable.
created. It defaults to `0o666`, readable and writable.

The callback gets two arguments `(err, fd)`.

Expand Down Expand Up @@ -1595,7 +1595,7 @@ changes:

* `path` {string|Buffer|URL}
* `flags` {string|number}
* `mode` {integer}
* `mode` {integer} **Default:** `0o666`

Synchronous version of [`fs.open()`][]. Returns an integer representing the file
descriptor.
Expand Down Expand Up @@ -1654,7 +1654,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`
* `callback` {Function}

Asynchronous readdir(3). Reads the contents of a directory.
Expand All @@ -1678,7 +1678,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`

Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`.
Expand Down Expand Up @@ -1711,8 +1711,8 @@ changes:

* `path` {string|Buffer|URL|integer} filename or file descriptor
* `options` {Object|string}
* `encoding` {string|null} default = `null`
* `flag` {string} default = `'r'`
* `encoding` {string|null} **Default:** `null`
* `flag` {string} **Default:** `'r'`
* `callback` {Function}

Asynchronously reads the entire contents of a file. Example:
Expand Down Expand Up @@ -1771,8 +1771,8 @@ changes:

* `path` {string|Buffer|URL|integer} filename or file descriptor
* `options` {Object|string}
* `encoding` {string|null} default = `null`
* `flag` {string} default = `'r'`
* `encoding` {string|null} **Default:** `null`
* `flag` {string} **Default:** `'r'`

Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.

Expand Down Expand Up @@ -1807,7 +1807,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`
* `callback` {Function}

Asynchronous readlink(2). The callback gets two arguments `(err,
Expand All @@ -1830,7 +1830,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`

Synchronous readlink(2). Returns the symbolic link's string value.

Expand Down Expand Up @@ -1882,7 +1882,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`
* `callback` {Function}

Asynchronous realpath(3). The `callback` gets two arguments `(err,
Expand Down Expand Up @@ -1920,7 +1920,7 @@ changes:

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} default = `'utf8'`
* `encoding` {string} **Default:** `'utf8'`

Synchronous realpath(3). Returns the resolved path.

Expand Down Expand Up @@ -2063,7 +2063,7 @@ changes:

* `target` {string|Buffer|URL}
* `path` {string|Buffer|URL}
* `type` {string}
* `type` {string} **Default:** `'file'`
* `callback` {Function}

Asynchronous symlink(2). No arguments other than a possible exception are given
Expand Down Expand Up @@ -2094,11 +2094,11 @@ changes:

* `target` {string|Buffer|URL}
* `path` {string|Buffer|URL}
* `type` {string}
* `type` {string} **Default:** `'file'`

Synchronous symlink(2). Returns `undefined`.

## fs.truncate(path, len, callback)
## fs.truncate(path[, len], callback)
<!-- YAML
added: v0.8.6
changes:
Expand All @@ -2109,20 +2109,20 @@ changes:
-->

* `path` {string|Buffer}
* `len` {integer} default = `0`
* `len` {integer} **Default:** `0`
* `callback` {Function}

Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback. A file descriptor can also be passed as the
first argument. In this case, `fs.ftruncate()` is called.

## fs.truncateSync(path, len)
## fs.truncateSync(path[, len])
<!-- YAML
added: v0.8.6
-->

* `path` {string|Buffer}
* `len` {integer} default = `0`
* `len` {integer} **Default:** `0`

Synchronous truncate(2). Returns `undefined`. A file descriptor can also be
passed as the first argument. In this case, `fs.ftruncateSync()` is called.
Expand Down Expand Up @@ -2167,7 +2167,7 @@ added: v0.1.31
-->

* `filename` {string|Buffer}
* `listener` {Function}
* `listener` {Function|undefined} **Default:** `undefined`

Stop watching for changes on `filename`. If `listener` is specified, only that
particular listener is removed. Otherwise, *all* listeners are removed,
Expand Down Expand Up @@ -2250,14 +2250,14 @@ changes:
* `filename` {string|Buffer|URL}
* `options` {string|Object}
* `persistent` {boolean} Indicates whether the process should continue to run
as long as files are being watched. default = `true`
as long as files are being watched. **Default:** `true`
* `recursive` {boolean} Indicates whether all subdirectories should be
watched, or only the current directory. This applies when a directory is
specified, and only on supported platforms (See [Caveats][]). default =
specified, and only on supported platforms (See [Caveats][]). **Default:**
`false`
* `encoding` {string} Specifies the character encoding to be used for the
filename passed to the listener. default = `'utf8'`
* `listener` {Function}
filename passed to the listener. **Default:** `'utf8'`
* `listener` {Function|undefined} **Default:** `undefined`

Watch for changes on `filename`, where `filename` is either a file or a
directory. The returned object is a [`fs.FSWatcher`][].
Expand Down Expand Up @@ -2357,8 +2357,8 @@ changes:

* `filename` {string|Buffer|URL}
* `options` {Object}
* `persistent` {boolean}
* `interval` {integer}
* `persistent` {boolean} **Default:** `true`
* `interval` {integer} **Default:** `5007`
* `listener` {Function}

Watch for changes on `filename`. The callback `listener` will be called each
Expand Down Expand Up @@ -2506,9 +2506,9 @@ changes:
* `file` {string|Buffer|integer} filename or file descriptor
* `data` {string|Buffer|Uint8Array}
* `options` {Object|string}
* `encoding` {string|null} default = `'utf8'`
* `mode` {integer} default = `0o666`
* `flag` {string} default = `'w'`
* `encoding` {string|null} **Default:** `'utf8'`
* `mode` {integer} **Default:** `0o666`
* `flag` {string} **Default:** `'w'`
* `callback` {Function}

Asynchronously writes data to a file, replacing the file if it already exists.
Expand Down Expand Up @@ -2556,9 +2556,9 @@ changes:
* `file` {string|Buffer|integer} filename or file descriptor
* `data` {string|Buffer|Uint8Array}
* `options` {Object|string}
* `encoding` {string|null} default = `'utf8'`
* `mode` {integer} default = `0o666`
* `flag` {string} default = `'w'`
* `encoding` {string|null} **Default:** `'utf8'`
* `mode` {integer} **Default:** `0o666`
* `flag` {string} **Default:** `'w'`

The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.

Expand Down