Skip to content

Commit 36f16e7

Browse files
trivikrtrivikr
authored
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 f9072f3 commit 36f16e7

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
@@ -7358,8 +7358,9 @@ Asynchronously read the next directory entry via readdir(3) as an
73587358
A promise is returned that will be fulfilled with an {fs.Dirent}, or `null`
73597359
if there are no more directory entries to read.
73607360
7361-
Directory entries returned by this function are in no particular order as
7362-
provided by the operating system's underlying directory mechanisms.
7361+
For directory reads handled by the native file system, directory entries
7362+
returned by this function are in no particular order as provided by the
7363+
operating system's underlying directory mechanisms.
73637364
Entries added or removed while iterating over the directory might not be
73647365
included in the iteration results.
73657366

0 commit comments

Comments
 (0)