doc: clarify that fs.create{Read,Write}Stream support AbortSignal

Refs: #36431 PR-URL: #47122 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Debadree Chatterjee <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Apr 5, 2023 · 5938a52 · 5938a52
1 parent 32b98f5
commit 5938a52
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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