Skip to content

fs: buffer dir entries in opendir() #29893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
addaleax wants to merge 6 commits into from
+159 −53
Closed

fs: buffer dir entries in opendir() #29893

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8bf527e
fs: buffer dir entries in opendir()
addaleax Oct 8, 2019
6d209fc
fixup! fs: buffer dir entries in opendir()
addaleax Oct 10, 2019
c66840d
doc: fs dir modifications may not be reflected by dir.read
addaleax Oct 10, 2019
e2f1071
fixup! fixup! fs: buffer dir entries in opendir()
addaleax Oct 10, 2019
59cf84d
fixup! fs: buffer dir entries in opendir()
addaleax Oct 10, 2019
751a8b6
fixup! fixup! fs: buffer dir entries in opendir()
addaleax Oct 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: fs dir modifications may not be reflected by dir.read
  • Loading branch information
@addaleax
addaleax committed Oct 10, 2019
commit c66840d0fa641907417ba5d75139e8e16a2d4ad3
24 changes: 16 additions & 8 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down