docs(ns): add a notice on file order returned by readDir (#21953)

This commit is contained in:
king8fisher 2024-01-15 23:57:06 -05:00 committed by GitHub
parent 4e72ca313a
commit 7d29eb0f63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -3415,7 +3415,7 @@ declare namespace Deno {
}
/** Reads the directory given by `path` and returns an async iterable of
* {@linkcode Deno.DirEntry}.
* {@linkcode Deno.DirEntry}. The order of entries is not guaranteed.
*
* ```ts
* for await (const dirEntry of Deno.readDir("/")) {
@ -3433,7 +3433,7 @@ declare namespace Deno {
export function readDir(path: string | URL): AsyncIterable<DirEntry>;
/** Synchronously reads the directory given by `path` and returns an iterable
* of `Deno.DirEntry`.
* of {@linkcode Deno.DirEntry}. The order of entries is not guaranteed.
*
* ```ts
* for (const dirEntry of Deno.readDirSync("/")) {