Skip to content

doc: synchronize argument names for appendFile() #20489

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 1 commit into from
Closed

doc: synchronize argument names for appendFile() #20489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -892,7 +892,7 @@ try {
}
```

## fs.appendFile(file, data[, options], callback)
## fs.appendFile(path, data[, options], callback)
<!-- YAML
added: v0.6.7
changes:
Expand All @@ -912,7 +912,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|URL|number} filename or file descriptor
* `path` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand All @@ -939,7 +939,7 @@ If `options` is a string, then it specifies the encoding. Example:
fs.appendFile('message.txt', 'data to append', 'utf8', callback);
```

The `file` may be specified as a numeric file descriptor that has been opened
The `path` may be specified as a numeric file descriptor that has been opened
for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
not be closed automatically.

Expand All @@ -955,7 +955,7 @@ fs.open('message.txt', 'a', (err, fd) => {
});
```

## fs.appendFileSync(file, data[, options])
## fs.appendFileSync(path, data[, options])
<!-- YAML
added: v0.6.7
changes:
Expand All @@ -967,7 +967,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->

* `file` {string|Buffer|URL|number} filename or file descriptor
* `path` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand All @@ -994,7 +994,7 @@ If `options` is a string, then it specifies the encoding. Example:
fs.appendFileSync('message.txt', 'data to append', 'utf8');
```

The `file` may be specified as a numeric file descriptor that has been opened
The `path` may be specified as a numeric file descriptor that has been opened
for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
not be closed automatically.

Expand Down Expand Up @@ -3687,12 +3687,12 @@ condition, since other processes may change the file's state between the two
calls. Instead, user code should open/read/write the file directly and handle
the error raised if the file is not accessible.

### fsPromises.appendFile(file, data[, options])
### fsPromises.appendFile(path, data[, options])
<!-- YAML
added: v10.0.0
-->

* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
* `path` {string|Buffer|URL|FileHandle} filename or `FileHandle`
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
Expand All @@ -3706,7 +3706,7 @@ resolved with no arguments upon success.

If `options` is a string, then it specifies the encoding.

The `file` may be specified as a `FileHandle` that has been opened
The `path` may be specified as a `FileHandle` that has been opened
for appending (using `fsPromises.open()`).

### fsPromises.chmod(path, mode)
Expand Down