Skip to content

Commit 6076111

Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
doc: qualify directory read ordering for native fs
Clarify that the documented operating system directory ordering applies to reads handled by the native file system. Signed-off-by: Kamat, Trivikram <[email protected]> PR-URL: #65868 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent d7e7308 commit 6076111

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7263,8 +7263,9 @@ Asynchronously read the next directory entry via readdir(3) as an
72637263
A promise is returned that will be fulfilled with an {fs.Dirent}, or `null`
72647264
if there are no more directory entries to read.
72657265
7266-
Directory entries returned by this function are in no particular order as
7267-
provided by the operating system's underlying directory mechanisms.
7266+
For directory reads handled by the native file system, directory entries
7267+
returned by this function are in no particular order as provided by the
7268+
operating system's underlying directory mechanisms.
72687269
Entries added or removed while iterating over the directory might not be
72697270
included in the iteration results.
72707271

0 commit comments

Comments
 (0)