readDir

Module @netwiv/api/plugins/fs · Kind Function

import { readDir } from '@netwiv/api/plugins/fs';

Reads the directory given by path and returns an array of DirEntry.

Signature

function readDir(path: string | URL, options?: ReadDirOptions | undefined): Promise<DirEntry[]>

Example

import { readDir, BaseDirectory } from '@netwiv/api/plugins/fs';
import { join } from '@netwiv/api/path';
const dir = "users"
const entries = await readDir('users', { baseDir: BaseDirectory.AppLocalData });
processEntriesRecursively(dir, entries);
async function processEntriesRecursively(parent, entries) {
  for (const entry of entries) {
    console.log(`Entry: ${entry.name}`);
    if (entry.isDirectory) {
       const dir = await join(parent, entry.name);
      processEntriesRecursively(dir, await readDir(dir, { baseDir: BaseDirectory.AppLocalData }))
    }
  }
}

Upstream since 2.0.0

---

Descriptions come from the pinned @tauri-apps/plugin-fs@2.5.2 declarations (MIT OR Apache-2.0); imports are shown with @netwiv/api paths.