Skip to content

Commit 5fc2bb7

Browse files
aduh95danielleadams
authored andcommitted
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
Refs: #36431 PR-URL: #47122 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Debadree Chatterjee <debadree333@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 2dd3b02 commit 5fc2bb7

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
@@ -2314,6 +2314,9 @@ changes:
23142314
- version: v16.10.0
23152315
pr-url: https://github.com/nodejs/node/pull/40013
23162316
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2317+
- version: v15.5.0
2318+
pr-url: https://github.com/nodejs/node/pull/36431
2319+
description: Add support for `AbortSignal`.
23172320
- version:
23182321
- v15.4.0
23192322
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2360,6 +2363,7 @@ changes:
23602363
* `end` {integer} **Default:** `Infinity`
23612364
* `highWaterMark` {integer} **Default:** `64 * 1024`
23622365
* `fs` {Object|null} **Default:** `null`
2366+
* `signal` {AbortSignal|null} **Default:** `null`
23632367
* Returns: {fs.ReadStream}
23642368
23652369
Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream
@@ -2439,6 +2443,9 @@ changes:
24392443
- version: v16.10.0
24402444
pr-url: https://github.com/nodejs/node/pull/40013
24412445
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2446+
- version: v15.5.0
2447+
pr-url: https://github.com/nodejs/node/pull/36431
2448+
description: Add support for `AbortSignal`.
24422449
- version:
24432450
- v15.4.0
24442451
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2481,6 +2488,7 @@ changes:
24812488
* `emitClose` {boolean} **Default:** `true`
24822489
* `start` {integer}
24832490
* `fs` {Object|null} **Default:** `null`
2491+
* `signal` {AbortSignal|null} **Default:** `null`
24842492
* Returns: {fs.WriteStream}
24852493
24862494
`options` may also include a `start` option to allow writing data at some

0 commit comments

Comments
 (0)