doc: clarify that `fs.create{Read,Write}Stream` support `AbortSignal` · nodejs/node@5fc2bb7 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 632
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 5fc2bb7

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored and

danielleadams

committed

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
Copy full SHA for 5fc2bb7

1 file changed

+8Lines changed: 8 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • fs.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md

+8Lines changed: 8 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -2314,6 +2314,9 @@ changes:
2314	2314	- version: v16.10.0
2315	2315	pr-url: https://github.com/nodejs/node/pull/40013
2316	2316	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`.
2317	2320	- version:
2318	2321	- v15.4.0
2319	2322	pr-url: https://github.com/nodejs/node/pull/35922
@@ -2360,6 +2363,7 @@ changes:
2360	2363	* `end` {integer} **Default:** `Infinity`
2361	2364	* `highWaterMark` {integer} **Default:** `64 * 1024`
2362	2365	* `fs` {Object|null} **Default:** `null`
	2366	+ * `signal` {AbortSignal|null} **Default:** `null`
2363	2367	* Returns: {fs.ReadStream}
2364	2368
2365	2369	Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream
@@ -2439,6 +2443,9 @@ changes:
2439	2443	- version: v16.10.0
2440	2444	pr-url: https://github.com/nodejs/node/pull/40013
2441	2445	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`.
2442	2449	- version:
2443	2450	- v15.4.0
2444	2451	pr-url: https://github.com/nodejs/node/pull/35922
@@ -2481,6 +2488,7 @@ changes:
2481	2488	* `emitClose` {boolean} **Default:** `true`
2482	2489	* `start` {integer}
2483	2490	* `fs` {Object|null} **Default:** `null`
	2491	+ * `signal` {AbortSignal|null} **Default:** `null`
2484	2492	* Returns: {fs.WriteStream}
2485	2493
2486	2494	`options` may also include a `start` option to allow writing data at some

0 commit comments

Comments

0 (0)