diff options
| author | ylemkimon <y@ylem.kim> | 2021-09-29 09:29:02 +0300 |
|---|---|---|
| committer | Qingyu Deng <i@ayase-lab.com> | 2021-10-07 12:09:30 +0300 |
| commit | b77e36cc45ec88144420d73de922b7437274e245 (patch) | |
| tree | 8ecf4bb620e289067ed430c7e83af3cdb26af81d /doc/api/fs.md | |
| parent | 88e82b890b1e0c6f9e3637a4ba781205f851ee1f (diff) | |
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>
Diffstat (limited to 'doc/api/fs.md')
| -rw-r--r-- | doc/api/fs.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index cea4f600ac8..4c2edc95a19 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -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 |