doc: note readStream.path if fd is specified

it'll be `undefined` if `fd` is specified.

Refs: https://github.com/nodejs/node/pull/40013

PR-URL: https://github.com/nodejs/node/pull/40252
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
ylemkimon 2021-09-29 15:29:02 +09:00 committed by Qingyu Deng
parent 88e82b890b
commit b77e36cc45
No known key found for this signature in database
GPG Key ID: 22201E473103C6C6
1 changed files with 2 additions and 1 deletions

View File

@ -5873,7 +5873,8 @@ added: v0.1.93
The path to the file the stream is reading from as specified in the first
argument to `fs.createReadStream()`. If `path` is passed as a string, then
`readStream.path` will be a string. If `path` is passed as a {Buffer}, then
`readStream.path` will be a {Buffer}.
`readStream.path` will be a {Buffer}. If `fd` is specified, then
`readStream.path` will be `undefined`.
#### `readStream.pending`
<!-- YAML