doc: clarify that fs.Dir async iterator closes automatically · nodejs/node@1eae4af · GitHub

nodejs / node Public

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

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

Additional navigation options

Commit 1eae4af

Browse filesBrowse the repository at this point in the historyBrowse files

jasnell

authored and

targos

committed

doc: clarify that fs.Dir async iterator closes automatically

Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: #35148 PR-URL: #38438 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

1 parent 195f679 commit 1eae4af
Copy full SHA for 1eae4af

1 file changed

+6Lines changed: 6 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

+6Lines changed: 6 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -901,6 +901,9 @@ try {
901	901	}
902	902	```
903	903
	904	+ When using the async iterator, the {fs.Dir} object will be automatically
	905	+ closed after the iterator exits.
	906	+
904	907	### `fsPromises.readdir(path[, options])`
905	908	<!-- YAML
906	909	added: v10.0.0
@@ -5119,6 +5122,9 @@ try {
5119	5122	}
5120	5123	```
5121	5124
	5125	+ When using the async iterator, the {fs.Dir} object will be automatically
	5126	+ closed after the iterator exits.
	5127	+
5122	5128	#### `dir.close()`
5123	5129	<!-- YAML
5124	5130	added: v12.12.0

0 commit comments

Comments

0 (0)