From e7dadd376ec535e56faf3be75fe23549bf13abc9 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 3 Jul 2020 13:03:56 -0700 Subject: [PATCH] doc: specify how fs.WriteStream/ReadStreams are created Alternative to https://github.com/nodejs/node/pull/33841 Co-authored-by: zombieleet PR-URL: https://github.com/nodejs/node/pull/34188 Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca --- doc/api/fs.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 9969412dbdb48f..3332444aa4353d 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -654,8 +654,8 @@ added: v0.1.93 * Extends: {stream.Readable} -A successful call to `fs.createReadStream()` will return a new `fs.ReadStream` -object. +Instances of `fs.ReadStream` are created and returned using the +[`fs.createReadStream()`][] function. ### Event: `'close'`