Skip to content

doc: clarify fs.read() #14631

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
Trott wants to merge 2 commits into from
Closed

doc: clarify fs.read() #14631

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75fa646
doc: clarify the position argument for fs.read
dcharbonnier Aug 3, 2017
93f3932
doc: improve fs.read() doc text
Trott Aug 4, 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
Next Next commit
doc: clarify the position argument for fs.read 
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

Fixes: #8397
  • Loading branch information
@dcharbonnier @Trott
dcharbonnier authored and Trott committed Aug 4, 2017
commit 75fa646f35c46df5a31554e9e3620a0f3a6e4979
4 changes: 3 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1640,7 +1640,9 @@ Read data from the file specified by `fd`.
`length` is an integer specifying the number of bytes to read.

`position` is an integer specifying where to begin reading from in the file.
If `position` is `null`, data will be read from the current file position.
If `position` is `null`, data will be read from the current file position,
and the file position will be updated for subsequent reads.
If `position` is an integer, the file position will remain unchanged.

The callback is given the three arguments, `(err, bytesRead, buffer)`.

Expand Down