doc: note readStream.path if fd is specified

it'll be `undefined` if `fd` is specified. Refs: #40013 PR-URL: #40252 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Oct 7, 2021 · b77e36c · b77e36c
1 parent 88e82b8
commit b77e36c
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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