Skip to content

Commit

Permalink
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
aduh95 authored and danielleadams committed Jul 6, 2023
1 parent 2dd3b02 commit 5fc2bb7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2314,6 +2314,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
Expand Down Expand Up @@ -2360,6 +2363,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
Expand Down Expand Up @@ -2439,6 +2443,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
Expand Down Expand Up @@ -2481,6 +2488,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
Expand Down

0 comments on commit 5fc2bb7

Please sign in to comment.