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 the behavior of readFile with fd #10853

Closed
wants to merge 1 commit into from
Closed

doc: clarify the behavior of readFile with fd #10853

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
3 changes: 2 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1347,7 +1347,8 @@ added: v0.1.29
* `flag` {String} default = `'r'`
* `callback` {Function}

Asynchronously reads the entire contents of a file. Example:
Asynchronously reads the entire contents of a file. If a file descriptor is
specified as the `file`, it will read from the current file position. Example:
Copy link
Member

Choose a reason for hiding this comment

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

I would make it more explicit:

If a file descriptor is specified as the `file`, reading will begin from the current
file position and not from the beginning of the file.


```js
fs.readFile('/etc/passwd', (err, data) => {
Expand Down