Browse Source

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.

PR-URL: https://github.com/nodejs/node/pull/14631
Fixes: https://github.com/https://github.com/nodejs/node/issues/8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
v6.x
dcharbonnier 8 years ago
committed by Myles Borins
parent
commit
5a7a49f505
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
  1. 4
      doc/api/fs.md

4
doc/api/fs.md

@ -1309,7 +1309,9 @@ Read data from the file specified by `fd`.
`length` is an integer specifying the number of bytes to read. `length` is an integer specifying the number of bytes to read.
`position` is an integer specifying where to begin reading from in the file. `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)`. The callback is given the three arguments, `(err, bytesRead, buffer)`.

Loading…
Cancel
Save