doc: clarify that fs.Dir async iterator closes automatically

Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: nodejs#35148
jasnell · Apr 27, 2021 · f17a968 · f17a968
1 parent bbe24e2
commit f17a968
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -901,6 +901,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
@@ -5119,6 +5122,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
@@ -5132,6 +5138,9 @@ Subsequent reads will result in errors.
 A promise is returned that will be resolved after the resource has been
 closed.
 
+When using the async iterator, the {fs.Dir} object will be automatically
+closed after the iterator exits.
+
 #### `dir.close(callback)`
 <!-- YAML
 added: v12.12.0