happy-opfs • Docs
happy-opfs / readDir
function readDir(dirPath, options?): AsyncIOResult<AsyncIterableIterator<ReadDirEntry>>
Reads the contents of a directory at the specified path.
Parameter | Type | Description |
---|---|---|
dirPath |
string |
The path of the directory to read. |
options ? |
ReadDirOptions |
Options of readdir. |
AsyncIOResult
<AsyncIterableIterator
<ReadDirEntry
>>
A promise that resolves to an AsyncIOResult
containing an async iterable iterator over the entries of the directory.