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

Jump to bottom

doc: clarify fd behaviour with {read,write}File #23706

Closed
wants to merge 7 commits into from
Closed

doc: clarify fd behaviour with {read,write}File #23706

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
351d9df
doc: clarify fd behaviour with {read,write}File
thefourtheye Oct 17, 2018
5370c14
address @vsemozhetbyt's comments
thefourtheye Oct 19, 2018
b5a440c
changes because of #23709
thefourtheye Oct 19, 2018
d44bf9f
group the relevant parts
thefourtheye Oct 19, 2018
121e1dd
update fs promisified functions' behaviour
thefourtheye Oct 19, 2018
9975e9a
Revert "changes because of #23709"
thefourtheye Oct 24, 2018
ef290a7
address review comments
thefourtheye Oct 24, 2018
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
35 changes: 27 additions & 8 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2547,14 +2547,18 @@ fs.readFile('<directory>', (err, data) => {
});
```

Any specified file descriptor has to support reading.

If a file descriptor is specified as the `path`, it will not be closed
automatically.

The `fs.readFile()` function buffers the entire file. To minimize memory costs,
when possible prefer streaming via `fs.createReadStream()`.

### File Descriptors
1. Any specified file descriptor has to support reading.
2. If a file descriptor is specified as the `path`, it will not be closed
automatically.
3. The reading will begin at the current position. For example, if the file
already had `'Hello World`' and six bytes are read with the file descriptor,
the call to `fs.readFile()` with the same file descriptor, would give
`'World'`, rather than `'Hello World'`.

## fs.readFileSync(path[, options])
<!-- YAML
added: v0.1.8
Expand Down Expand Up @@ -3540,14 +3544,19 @@ If `options` is a string, then it specifies the encoding:
fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);
```

Any specified file descriptor has to support writing.

It is unsafe to use `fs.writeFile()` multiple times on the same file without
waiting for the callback. For this scenario, [`fs.createWriteStream()`][] is
recommended.

If a file descriptor is specified as the `file`, it will not be closed
### File Descriptors
1. Any specified file descriptor has to support writing.
2. If a file descriptor is specified as the `file`, it will not be closed
automatically.
3. The writing will begin at the beginning of the file. For example, if the
file already had `'Hello World'` and the newly written content is `'Aloha'`,
then the contents of the file would be `'Aloha World'`, rather than just
`'Aloha'`.


## fs.writeFileSync(file, data[, options])
<!-- YAML
Expand Down Expand Up @@ -3780,6 +3789,11 @@ returned.

The `FileHandle` has to support reading.

If one or more `filehandle.read()` calls are made on a file handle and then a
`filehandle.readFile()` call is made, the data will be read from the current
position till the end of the file. It doesn't always read from the beginning
of the file.

#### filehandle.stat([options])
<!-- YAML
added: v10.0.0
Expand Down Expand Up @@ -3942,6 +3956,11 @@ The `FileHandle` has to support writing.
It is unsafe to use `filehandle.writeFile()` multiple times on the same file
without waiting for the `Promise` to be resolved (or rejected).

If one or more `filehandle.write()` calls are made on a file handle and then a
`filehandle.writeFile()` call is made, the data will be written from the
current position till the end of the file. It doesn't always write from the
beginning of the file.

### fsPromises.access(path[, mode])
<!-- YAML
added: v10.0.0
Expand Down