Skip to content

Commit 05fdae9

Browse files
aduh95pull[bot]
authored andcommitted
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 be9dbb7 commit 05fdae9

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
@@ -2333,6 +2333,9 @@ changes:
23332333
- version: v16.10.0
23342334
pr-url: https://github.com/nodejs/node/pull/40013
23352335
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2336+
- version: v15.5.0
2337+
pr-url: https://github.com/nodejs/node/pull/36431
2338+
description: Add support for `AbortSignal`.
23362339
- version:
23372340
- v15.4.0
23382341
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2379,6 +2382,7 @@ changes:
23792382
* `end` {integer} **Default:** `Infinity`
23802383
* `highWaterMark` {integer} **Default:** `64 * 1024`
23812384
* `fs` {Object|null} **Default:** `null`
2385+
* `signal` {AbortSignal|null} **Default:** `null`
23822386
* Returns: {fs.ReadStream}
23832387
23842388
Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream
@@ -2458,6 +2462,9 @@ changes:
24582462
- version: v16.10.0
24592463
pr-url: https://github.com/nodejs/node/pull/40013
24602464
description: The `fs` option does not need `close` method if `autoClose` is `false`.
2465+
- version: v15.5.0
2466+
pr-url: https://github.com/nodejs/node/pull/36431
2467+
description: Add support for `AbortSignal`.
24612468
- version:
24622469
- v15.4.0
24632470
pr-url: https://github.com/nodejs/node/pull/35922
@@ -2500,6 +2507,7 @@ changes:
25002507
* `emitClose` {boolean} **Default:** `true`
25012508
* `start` {integer}
25022509
* `fs` {Object|null} **Default:** `null`
2510+
* `signal` {AbortSignal|null} **Default:** `null`
25032511
* Returns: {fs.WriteStream}
25042512
25052513
`options` may also include a `start` option to allow writing data at some

0 commit comments

Comments
 (0)