Skip to content

Commit

Permalink
doc: note readStream.path if fd is specified
Browse files Browse the repository at this point in the history
it'll be `undefined` if `fd` is specified.

Refs: #40013

PR-URL: #40252
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
ylemkimon authored and Ayase-252 committed Oct 7, 2021
1 parent 88e82b8 commit b77e36c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b77e36c

Please sign in to comment.