Skip to content

Commit c45a697

Browse files
aduh95RafaelGSS
authored andcommittedApr 7, 2023
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]>
1 parent 82c7757 commit c45a697

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed
 

‎doc/api/fs.md

+8
Original file line numberDiff line numberDiff line change
@@ -2331,6 +2331,9 @@ changes:
23312331
- version: v16.10.0
23322332
pr-url: https://github.com/nodejs/node/pull/40013
23332333
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2334+
- version: v15.5.0
2335+
pr-url: https://github.com/nodejs/node/pull/36431
2336+
description: Add support for `AbortSignal`.
23342337
- version:
23352338
- v15.4.0
23362339
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2377,6 +2380,7 @@ changes:
23772380
* `end` {integer} **Default:** `Infinity`
23782381
* `highWaterMark` {integer} **Default:** `64 * 1024`
23792382
* `fs` {Object|null} **Default:** `null`
2383+
* `signal` {AbortSignal|null} **Default:** `null`
23802384
* Returns: {fs.ReadStream}
23812385
23822386
Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream
@@ -2456,6 +2460,9 @@ changes:
24562460
- version: v16.10.0
24572461
pr-url: https://github.com/nodejs/node/pull/40013
24582462
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2463+
- version: v15.5.0
2464+
pr-url: https://github.com/nodejs/node/pull/36431
2465+
description: Add support for `AbortSignal`.
24592466
- version:
24602467
- v15.4.0
24612468
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2498,6 +2505,7 @@ changes:
24982505
* `emitClose` {boolean} **Default:** `true`
24992506
* `start` {integer}
25002507
* `fs` {Object|null} **Default:** `null`
2508+
* `signal` {AbortSignal|null} **Default:** `null`
25012509
* Returns: {fs.WriteStream}
25022510
25032511
`options` may also include a `start` option to allow writing data at some

0 commit comments

Comments
 (0)
Please sign in to comment.