doc: clarify that fs.Dir async iterator closes automatically

Signed-off-by: James M Snell <[email protected]> Fixes: #35148 PR-URL: #38438 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · Sep 4, 2021 · 7a92c3c · 7a92c3c
1 parent b819848
commit 7a92c3c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -905,6 +905,9 @@ try {
 }
 ```
 
+When using the async iterator, the {fs.Dir} object will be automatically
+closed after the iterator exits.
+
 ### `fsPromises.readdir(path[, options])`
 <!-- YAML
 added: v10.0.0
@@ -5076,6 +5079,9 @@ try {
 }
 ```
 
+When using the async iterator, the {fs.Dir} object will be automatically
+closed after the iterator exits.
+
 #### `dir.close()`
 <!-- YAML
 added: v12.12.0