From 5938a52d8b2ec5e16e415e302f65fa650cc64adb Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Sat, 18 Mar 2023 18:21:51 +0100 Subject: [PATCH] doc: clarify that `fs.create{Read,Write}Stream` support `AbortSignal` Refs: https://github.com/nodejs/node/pull/36431 PR-URL: https://github.com/nodejs/node/pull/47122 Reviewed-By: Yagiz Nizipli Reviewed-By: Debadree Chatterjee Reviewed-By: Luigi Pinca --- doc/api/fs.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 4070cc4955309a..63c3c0b9d69f86 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2331,6 +2331,9 @@ changes: - version: v16.10.0 pr-url: https://github.com/nodejs/node/pull/40013 description: The `fs` option does not need `close` method if `autoClose` is `false`. + - version: v15.5.0 + pr-url: https://github.com/nodejs/node/pull/36431 + description: Add support for `AbortSignal`. - version: - v15.4.0 pr-url: https://github.com/nodejs/node/pull/35922 @@ -2377,6 +2380,7 @@ changes: * `end` {integer} **Default:** `Infinity` * `highWaterMark` {integer} **Default:** `64 * 1024` * `fs` {Object|null} **Default:** `null` + * `signal` {AbortSignal|null} **Default:** `null` * Returns: {fs.ReadStream} Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream @@ -2456,6 +2460,9 @@ changes: - version: v16.10.0 pr-url: https://github.com/nodejs/node/pull/40013 description: The `fs` option does not need `close` method if `autoClose` is `false`. + - version: v15.5.0 + pr-url: https://github.com/nodejs/node/pull/36431 + description: Add support for `AbortSignal`. - version: - v15.4.0 pr-url: https://github.com/nodejs/node/pull/35922 @@ -2498,6 +2505,7 @@ changes: * `emitClose` {boolean} **Default:** `true` * `start` {integer} * `fs` {Object|null} **Default:** `null` + * `signal` {AbortSignal|null} **Default:** `null` * Returns: {fs.WriteStream} `options` may also include a `start` option to allow writing data at some