From cff0c12b51473bc479c88f32122cb40b364a563b Mon Sep 17 00:00:00 2001 From: ylemkimon Date: Wed, 29 Sep 2021 15:29:02 +0900 Subject: [PATCH] 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 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/fs.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 28d7f2c3e2c570..44683a03b4b7bb 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -5807,7 +5807,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`