Commit e40876a
doc: specify how to detect EOF
Specify how to detect end-of-file when using `fs.read()` and
`filehandle.read()`.
PR-URL: #35445
Fixes: #35363
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>1 parent 541ce17 commit e40876a
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2909,6 +2909,9 @@ If `position` is an integer, the file position will remain unchanged. | |||
| 2909 | 2909 | ||
| 2910 | 2910 | The callback is given the three arguments, `(err, bytesRead, buffer)`. | |
| 2911 | 2911 | ||
| 2912 | + If the file is not modified concurrently, the end-of-file is reached when the | ||
| 2913 | + number of bytes read is zero. | ||
| 2914 | + | ||
| 2912 | 2915 | If this method is invoked as its [`util.promisify()`][]ed version, it returns | |
| 2913 | 2916 | a `Promise` for an `Object` with `bytesRead` and `buffer` properties. | |
| 2914 | 2917 | ||
@@ -4657,6 +4660,9 @@ Following successful read, the `Promise` is resolved with an object with a | |||
| 4657 | 4660 | `bytesRead` property specifying the number of bytes read, and a `buffer` | |
| 4658 | 4661 | property that is a reference to the passed in `buffer` argument. | |
| 4659 | 4662 | ||
| 4663 | + If the file is not modified concurrently, the end-of-file is reached when the | ||
| 4664 | + number of bytes read is zero. | ||
| 4665 | + | ||
| 4660 | 4666 | #### `filehandle.read(options)` | |
| 4661 | 4667 | <!-- YAML | |
| 4662 | 4668 | added: v13.11.0 | |
0 commit comments