Interface ReadDirOptions

Options for reading directories.

interface ReadDirOptions {
recursive?: boolean;
signal?: AbortSignal;
}

Properties

recursive?: boolean

Whether to recursively read the contents of subdirectories.

false

signal?: AbortSignal

An optional AbortSignal to abort the directory traversal. When aborted, the iterator will stop yielding entries.