readDirectory

Liste les entrées d'un dossier.

Exemple

import { SF } from "@duplojs/server-utils";
import { E, unwrap } from "@duplojs/utils";

const entries = await SF.readDirectory("/tmp");
// entries: E.Success<string[]> | SF.FileSystemLeft

if (E.isRight(entries)) {
	const list = unwrap(entries);
	// list: string[]
}

const recursive = await SF.readDirectory("/tmp", { recursive: true });
// recursive: E.Success<string[]> | SF.FileSystemLeft

Syntaxe

function readDirectory(
  path: string | URL,
  params?: {
    recursive?: true
  }
): Promise<FileSystemLeft | E.Success<string[]>>

Paramètres

• path : chemin du dossier a lister.
• params.recursive : liste aussi les sous-dossiers si true.

Valeur de retour

• E.Success<string[]> : liste des entrées.
• FileSystemLeft : si la lecture échoue.

Voir aussi

• makeDirectory - Crée un dossier.