From e40876a5e569d270b7ad051f1354eae335a29263 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Thu, 1 Oct 2020 15:51:40 +0200 Subject: [PATCH] doc: specify how to detect EOF Specify how to detect end-of-file when using `fs.read()` and `filehandle.read()`. PR-URL: https://github.com/nodejs/node/pull/35445 Fixes: https://github.com/nodejs/node/issues/35363 Reviewed-By: James M Snell Reviewed-By: Gireesh Punathil Reviewed-By: Anna Henningsen Reviewed-By: Rich Trott Reviewed-By: Colin Ihrig Reviewed-By: Zeyu Yang Reviewed-By: Andrey Pechkurov --- doc/api/fs.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 72357443ecef15..36d3fc10f4df54 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2909,6 +2909,9 @@ If `position` is an integer, the file position will remain unchanged. The callback is given the three arguments, `(err, bytesRead, buffer)`. +If the file is not modified concurrently, the end-of-file is reached when the +number of bytes read is zero. + If this method is invoked as its [`util.promisify()`][]ed version, it returns a `Promise` for an `Object` with `bytesRead` and `buffer` properties. @@ -4657,6 +4660,9 @@ Following successful read, the `Promise` is resolved with an object with a `bytesRead` property specifying the number of bytes read, and a `buffer` property that is a reference to the passed in `buffer` argument. +If the file is not modified concurrently, the end-of-file is reached when the +number of bytes read is zero. + #### `filehandle.read(options)`