From d604173a66105e82d14f04ff4cf72310f619f6bc Mon Sep 17 00:00:00 2001 From: dcharbonnier Date: Thu, 3 Aug 2017 19:37:09 +0200 Subject: [PATCH] doc: clarify the position argument for fs.read MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Colin Ihrig Reviewed-By: Tobias Nießen --- doc/api/fs.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index e151f0fed89a15..0107b0a2311c85 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -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)`.