more documentation...

This commit is contained in:
2023-06-04 09:34:11 +00:00
parent de71e679ec
commit dc4501b5f2
23 changed files with 737 additions and 69 deletions

View File

@@ -1,5 +1,28 @@
## fs
Das FsPackage-Interface bietet Funktionen zur Datei- und Verzeichnisverwaltung. Es beinhaltet folgende Methoden:
- `configDir(): string`:
Diese Methode gibt den Pfad zum Verzeichnis der API-Konfigurationsdatei zurück.
- `readFile(path: string, options?: {}): string | any`:
Diese Methode nimmt einen relativen Pfad zu einer Datei und optionale Leseoptionen entgegen und gibt den Inhalt dieser Datei zurück. Die Optionen können steuern, ob der Inhalt als Byte-Array oder als Zeichenkette zurückgegeben wird.
- `writeFile(path: string, data: string | any): null`:
Diese Methode nimmt einen relativen Pfad zu einer Datei und Daten entgegen und schreibt diese Daten in die Datei.
- `stat(path: string): {}`:
Diese Methode nimmt einen Pfad zu einer Datei oder einem Verzeichnis entgegen und gibt Informationen über diese Datei oder dieses Verzeichnis zurück.
- `readDir(path: string): {}[]`:
Diese Methode nimmt einen Pfad zu einem Verzeichnis entgegen und gibt eine Liste der darin enthaltenen Dateien und Verzeichnisse zurück.
- `mkDir(path: string): void`:
Diese Methode nimmt einen Pfad entgegen und erstellt an diesem Ort ein neues Verzeichnis.
- `remove(path: string): void`:
Diese Methode nimmt einen Pfad entgegen und löscht die Datei oder das leere Verzeichnis an diesem Pfad.
```ts
interface FsPackage {
/**