FileSystemDirectoryHandle

Instanz-Eigenschaften

Erbt Eigenschaften von seinem Elternteil, FileSystemHandle.

Instanz-Methoden

Erbt Methoden von seinem Elternteil, FileSystemHandle.

Reguläre Methoden:

FileSystemDirectoryHandle.getDirectoryHandle()

Gibt ein Promise zurück, das mit einem FileSystemDirectoryHandle für ein Unterverzeichnis mit dem angegebenen Namen, innerhalb des Verzeichnisses, auf dem die Methode aufgerufen wird, erfüllt wird.

FileSystemDirectoryHandle.getFileHandle()

Gibt ein Promise zurück, das mit einem FileSystemFileHandle für eine Datei mit dem angegebenen Namen, innerhalb des Verzeichnisses, auf dem die Methode aufgerufen wird, erfüllt wird.

FileSystemDirectoryHandle.removeEntry()

Versucht, asynchron einen Eintrag zu entfernen, wenn das Verzeichnis-Handle eine Datei oder ein Verzeichnis mit dem angegebenen Namen enthält.

FileSystemDirectoryHandle.resolve()

Gibt ein Promise zurück, das mit einem Array von Verzeichnisnamen vom übergeordneten Handle zum angegebenen Kindeintrag erfüllt wird, wobei der Name des Kindeintrags das letzte Array-Element ist.

Asynchroner Iterator Methoden:

FileSystemDirectoryHandle.entries()

Gibt einen neuen asynchronen Iterator der eigenen aufzählbaren Eigenschaften [key, value] Paare eines gegebenen Objekts zurück.

FileSystemDirectoryHandle.keys()

Gibt einen neuen asynchronen Iterator zurück, der die Schlüssel für jedes Element in FileSystemDirectoryHandle enthält.

FileSystemDirectoryHandle.values()

Gibt einen neuen asynchronen Iterator zurück, der die Werte für jeden Index im FileSystemDirectoryHandle-Objekt enthält.

FileSystemDirectoryHandle[Symbol.asyncIterator]()

Gibt einen neuen asynchronen Iterator der eigenen aufzählbaren Eigenschaften [key, value] Paare eines gegebenen Objekts zurück.

Beispiele

Verzeichnis-Handle zurückgeben

Das folgende Beispiel gibt ein Verzeichnis-Handle mit dem angegebenen Namen zurück; falls das Verzeichnis noch nicht existiert, wird es erstellt.

const dirName = "directoryToGetName";

// assuming we have a directory handle: 'currentDirHandle'
const subDir = await currentDirHandle.getDirectoryHandle(dirName, {
  create: true,
});

Dateipfad zurückgeben

Die folgende asynchrone Funktion verwendet resolve(), um den Pfad zu einer ausgewählten Datei relativ zu einem angegebenen Verzeichnis-Handle zu finden.

async function returnPathDirectories(directoryHandle) {
  // Get a file handle by showing a file picker:
  const handle = await self.showOpenFilePicker();
  if (!handle) {
    // User canceled, or otherwise failed to open a file.
    return;
  }

  // Check if handle exists inside our directory handle
  const relativePaths = await directoryHandle.resolve(handle);

  if (relativePaths === null) {
    // Not inside directory handle
  } else {
    // relativePath is an array of names, giving the relative path

    for (const name of relativePaths) {
      // log each entry
      console.log(name);
    }
  }
}

Handles für alle Dateien in einem Verzeichnis zurückgeben

Das folgende Beispiel durchsucht rekursiv ein Verzeichnis, um FileSystemFileHandle-Objekte für jede Datei in diesem Verzeichnis zurückzugeben:

async function* getFilesRecursively(entry) {
  if (entry.kind === "file") {
    const file = await entry.getFile();
    if (file !== null) {
      file.relativePath = getRelativePath(entry);
      yield file;
    }
  } else if (entry.kind === "directory") {
    for await (const handle of entry.values()) {
      yield* getFilesRecursively(handle);
    }
  }
}
for await (const fileHandle of getFilesRecursively(directoryHandle)) {
  console.log(fileHandle);
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• File System API
• The File System Access API: simplifying access to local files