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

nodejs / node Public

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

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

Additional navigation options

Commit c45a697

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored and

RafaelGSS

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 82c7757 commit c45a697
Copy full SHA for c45a697

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
@@ -2331,6 +2331,9 @@ changes:
2331	2331	- version: v16.10.0
2332	2332	pr-url: https://github.com/nodejs/node/pull/40013
2333	2333	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`.
2334	2337	- version:
2335	2338	- v15.4.0
2336	2339	pr-url: https://github.com/nodejs/node/pull/35922
@@ -2377,6 +2380,7 @@ changes:
2377	2380	* `end` {integer} **Default:** `Infinity`
2378	2381	* `highWaterMark` {integer} **Default:** `64 * 1024`
2379	2382	* `fs` {Object|null} **Default:** `null`
	2383	+ * `signal` {AbortSignal|null} **Default:** `null`
2380	2384	* Returns: {fs.ReadStream}
2381	2385
2382	2386	Unlike the 16 KiB default `highWaterMark` for a {stream.Readable}, the stream
@@ -2456,6 +2460,9 @@ changes:
2456	2460	- version: v16.10.0
2457	2461	pr-url: https://github.com/nodejs/node/pull/40013
2458	2462	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`.
2459	2466	- version:
2460	2467	- v15.4.0
2461	2468	pr-url: https://github.com/nodejs/node/pull/35922
@@ -2498,6 +2505,7 @@ changes:
2498	2505	* `emitClose` {boolean} **Default:** `true`
2499	2506	* `start` {integer}
2500	2507	* `fs` {Object|null} **Default:** `null`
	2508	+ * `signal` {AbortSignal|null} **Default:** `null`
2501	2509	* Returns: {fs.WriteStream}
2502	2510
2503	2511	`options` may also include a `start` option to allow writing data at some

0 commit comments

Comments

0 (0)