Skip to content

Commit

Permalink
doc: improve fs.read() doc text
Browse files Browse the repository at this point in the history
PR-URL: #14631
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
  • Loading branch information
Trott authored and addaleax committed Aug 10, 2017
1 parent d604173 commit 9888bb1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1639,9 +1639,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,
and the file position will be updated for subsequent reads.
`position` is an argument specifying where to begin reading from in the file.
If `position` is `null`, data will be read from the current file position,
and the file position will be updated.
If `position` is an integer, the file position will remain unchanged.

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

0 comments on commit 9888bb1

Please sign in to comment.