Skip to content
Permalink
Browse files

doc: fs dir modifications may not be reflected by dir.read

PR-URL: #29893
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
  • Loading branch information
addaleax authored and targos committed Oct 10, 2019
1 parent 216e200 commit 1fefd7fddc4092908b6660b8b4f6ccd6081102ec
Showing with 16 additions and 8 deletions.
  1. +16 −8 doc/api/fs.md
@@ -362,8 +362,10 @@ Asynchronously read the next directory entry via readdir(3) as an
After the read is completed, a `Promise` is returned that will be resolved with
an [`fs.Dirent`][], or `null` if there are no more directory entries to read.

_Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms._
Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms.
Entries added or removed while iterating over the directory may or may not be
included in the iteration results.

### dir.read(callback)
<!-- YAML
@@ -380,8 +382,10 @@ Asynchronously read the next directory entry via readdir(3) as an
After the read is completed, the `callback` will be called with an
[`fs.Dirent`][], or `null` if there are no more directory entries to read.

_Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms._
Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms.
Entries added or removed while iterating over the directory may or may not be
included in the iteration results.

### dir.readSync()
<!-- YAML
@@ -395,8 +399,10 @@ Synchronously read the next directory entry via readdir(3) as an

If there are no more directory entries to read, `null` will be returned.

_Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms._
Directory entries returned by this function are in no particular order as
provided by the operating system's underlying directory mechanisms.
Entries added or removed while iterating over the directory may or may not be
included in the iteration results.

### dir\[Symbol.asyncIterator\]()
<!-- YAML
@@ -413,8 +419,10 @@ The `null` case from `dir.read()` is handled internally.

See [`fs.Dir`][] for an example.

_Directory entries returned by this iterator are in no particular order as
provided by the operating system's underlying directory mechanisms._
Directory entries returned by this iterator are in no particular order as
provided by the operating system's underlying directory mechanisms.
Entries added or removed while iterating over the directory may or may not be
included in the iteration results.

## Class: fs.Dirent
<!-- YAML

0 comments on commit 1fefd7f

Please sign in to comment.
You can’t perform that action at this time.