DirectoryReaderSync

Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, kann sie bereits aus den relevanten Webstandards entfernt worden sein, befindet sich im Prozess der Entfernung oder wird nur aus Kompatibilitätsgründen beibehalten. Vermeiden Sie die Verwendung und aktualisieren Sie gegebenenfalls bestehenden Code; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu treffen. Beachten Sie, dass diese Funktion jederzeit nicht mehr funktionieren kann.

Das DirectoryReaderSync-Interface ermöglicht es, die Einträge in einem Verzeichnis zu lesen.

Warnung: Dieses Interface ist veraltet und ist nicht mehr auf dem Standardpfad. Verwenden Sie es nicht mehr. Nutzen Sie stattdessen die File and Directory Entries API.

Grundkonzepte

Bevor Sie die einzige Methode in diesem Interface, readEntries(), aufrufen, erstellen Sie das DirectoryEntrySync-Objekt. Aber DirectoryEntrySync (sowie FileEntrySync) ist kein Datentyp, den Sie zwischen einer aufrufenden App und einem Web Worker-Thread übergeben können. Das ist kein großes Problem, da es nicht wirklich nötig ist, dass die Haupt-App und der Worker-Thread dasselbe JavaScript-Objekt sehen; sie müssen lediglich auf dieselben Dateien zugreifen können. Sie können dies erreichen, indem Sie anstelle einer Liste von Einträgen eine Liste von filesystem:-URLs übergeben—die einfach nur Zeichenketten sind. Sie können die filesystem:-URL auch verwenden, um den Eintrag mit resolveLocalFileSystemURL() nachzuschlagen. Damit gelangen Sie zurück zu einem DirectoryEntrySync (sowie FileEntrySync)-Objekt.

Beispiel

Im folgenden Code-Schnipsel von HTML5Rocks (web.dev) erstellen wir Web Worker und übergeben Daten davon an die Hauptanwendung.

// Taking care of the browser-specific prefixes.
window.resolveLocalFileSystemURL =
  window.resolveLocalFileSystemURL || window.webkitResolveLocalFileSystemURL;

// Create web workers
const worker = new Worker("worker.js");
worker.onmessage = (e) => {
  const urls = e.data.entries;
  urls.forEach((url) => {
    window.resolveLocalFileSystemURL(url, (fileEntry) => {
      // Print out file's name.
      console.log(fileEntry.name);
    });
  });
};

worker.postMessage({ cmd: "list" });

Das Folgende ist der Code von worker.js, der den Inhalt des Verzeichnisses abrufen lässt.

// worker.js

// Taking care of the browser-specific prefixes.
self.requestFileSystemSync =
  self.webkitRequestFileSystemSync || self.requestFileSystemSync;

// Global for holding the list of entry file system URLs.
const paths = [];

function getAllEntries(dirReader) {
  const entries = dirReader.readEntries();

  for (const entry of entries) {
    // Stash this entry's filesystem in URL
    paths.push(entry.toURL());

    // If this is a directory, traverse.
    if (entry.isDirectory) {
      getAllEntries(entry.createReader());
    }
  }
}

// Forward the error to main app.
function onError(e) {
  postMessage(`ERROR: ${e.toString()}`);
}

self.onmessage = (e) => {
  const cmd = e.data.cmd;

  // Ignore everything else except our 'list' command.
  if (!cmd || cmd !== "list") {
    return;
  }

  try {
    const fs = requestFileSystemSync(TEMPORARY, 1024 * 1024 /*1MB*/);

    getAllEntries(fs.root.createReader());

    self.postMessage({ entries: paths });
  } catch (e) {
    onError(e);
  }
};

Methode

readEntries()

Gibt eine Liste von Einträgen aus einem bestimmten Verzeichnis zurück. Rufen Sie diese Methode auf, bis ein leeres Array zurückgegeben wird.

Syntax

readEntries()

Parameter

Keine.

Rückgabewert

Array, das FileEntrySync und DirectoryEntrySync enthält.

Ausnahmen

Diese Methode kann eine DOMException mit den folgenden Codes auslösen:

Ausnahme	Beschreibung
`NOT_FOUND_ERR`	Das Verzeichnis existiert nicht.
`INVALID_STATE_ERR`	Das Verzeichnis wurde seit dem ersten Aufruf von readEntries verändert.
`SECURITY_ERR`	Der Browser hat bestimmt, dass es nicht sicher ist, die Metadaten nachzuschlagen.