DirectoryReaderSync
Deprecated
Avoid using this feature in new projects. This feature may be a candidate for removal from web standards or browsers.
Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.
Das DirectoryReaderSync-Interface ermöglicht das Lesen der Einträge in einem Verzeichnis.
Warnung: Dieses Interface ist veraltet und gehört nicht mehr zum Standard. Verwenden Sie es nicht mehr. Verwenden Sie stattdessen die Datei- und Verzeichniseintrags-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 Anwendung und einem Web Worker-Thread übergeben können. Das ist nicht weiter problematisch, da die Hauptanwendung und der Worker-Thread nicht dasselbe JavaScript-Objekt sehen müssen; Sie müssen nur Zugriff auf dieselben Dateien haben. Dies können Sie erreichen, indem Sie eine Liste von filesystem:-URLs—die einfach nur Zeichenfolgen sind—anstatt einer Liste von Einträgen übergeben. Sie können auch die filesystem:-URL verwenden, um den Eintrag mit resolveLocalFileSystemURL() nachzuschlagen. Das bringt Sie zurück zu einem DirectoryEntrySync (sowie FileEntrySync)-Objekt.
Beispiel
Im folgenden Codeausschnitt von HTML5Rocks (web.dev) erstellen wir Web Workers und übergeben Daten davon zur 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 worker.js-Code liest den Inhalt des Verzeichnisses.
// 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 geändert. |
SECURITY_ERR |
Der Browser hat bestimmt, dass es nicht sicher ist, die Metadaten abzurufen. |
Spezifikationen
Dieses Feature gehört nicht mehr zu einer Spezifikation. Es ist nicht mehr auf dem Weg, ein Standard zu werden.