Skip to content

doc: add a note about readStream.path if fd is specified #40252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ylemkimon wants to merge 1 commit into from
Closed

doc: add a note about readStream.path if fd is specified #40252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: note readStream.path if fd is specified 
#40013 changed the behavior of `readStream.path`, it'll be `undefined` if `fd` is specified.
  • Loading branch information
@ylemkimon
ylemkimon authored Sep 29, 2021
commit 0fbdf070f7671ad079e4ef9601f28bbc6dfa4af7
3 changes: 2 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
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