readdir
Reads the contents of a directory and returns an array of DirEntry objects.
Signature
readdir(path: string, options?: ReaddirOptions): Result<DirEntry[], FsError>Read options
ReaddirOptions is an interface with one optional field:
recursive?: boolean, whentrue, recursively traverses subdirectories and includes their entries in the result. Defaults tofalse.
Directory entries
Each DirEntry has readonly name: string and type: DirEntryType fields. DirEntryType is an enum with File, Directory, Symlink, and Other members, so callers can branch on an entry's kind without inspecting its name.
Example
tyrus
import { FsError, readdir } from "tyrus:fs";
match (readdir(".")) {
Ok(entries) => { print(entries.length); } // 3
Err(error) => { printError(error.code); } // ERR_FS_READ_FAILED
}Error handling
Returns Err(FsError) with code ERR_FS_READ_FAILED if the root directory or any directory traversed recursively cannot be read, or if an entry cannot be inspected. The operation does not return a partial listing.
error
tyrus
import { FsError, readdir } from "tyrus:fs";
match (readdir("/nonexistent")) {
Ok(entries) => { print(entries.length); }
Err(error) => { printError(error.code); } // ERR_FS_READ_FAILED
}