FileSystemObserver: observe() Methode

handle

Der Handle des Dateisystemeintrags, der die zu beobachtende Datei oder das Verzeichnis darstellt.

• Für das benutzerbeobachtbare Dateisystem kann dies ein FileSystemFileHandle oder ein FileSystemDirectoryHandle sein.
• Für das Origin Private File System (OPFS) kann es ein FileSystemFileHandle, ein FileSystemDirectoryHandle oder ein FileSystemSyncAccessHandle sein.

options Optional

Ein Objekt, das Optionen für den observe()-Aufruf angibt. Dies kann die folgenden Eigenschaften enthalten:

recursive

Ein boolescher Wert, der angibt, ob Sie Änderungen an einem Verzeichnis rekursiv beobachten möchten. Wenn auf true gesetzt, werden Änderungen im Verzeichnis selbst und in allen enthaltenen Unterverzeichnissen und Dateien beobachtet. Wenn auf false gesetzt, werden Änderungen nur im Verzeichnis selbst und in direkt enthaltenen Dateien beobachtet (das heißt, Dateien in Unterverzeichnissen sind ausgeschlossen). Standardmäßig false.

Diese Eigenschaft hat keine Auswirkung, wenn handle eine Datei darstellt.

Ein Promise, das sich in undefined auflöst.

NotFoundError DOMException

Ausgelöst, wenn die Datei oder das Verzeichnis, das durch handle repräsentiert wird, nicht gefunden werden konnte.

Wenn eine Instanz von FileSystemObserver verfügbar ist, können Sie Änderungen an einem Dateisystemeintrag beobachten, indem Sie observe() aufrufen.

Sie können eine Datei oder ein Verzeichnis im benutzerbeobachtbaren Dateisystem oder im Origin Private File System (OPFS) beobachten, indem Sie ein FileSystemFileHandle oder FileSystemDirectoryHandle an observe() übergeben. Instanzen dieser Objekte können beispielsweise zurückgegeben werden, wenn der Benutzer aufgefordert wird, eine Datei oder ein Verzeichnis mit Window.showSaveFilePicker() oder Window.showDirectoryPicker() auszuwählen:

// Observe a file
async function observeFile() {
  const fileHandle = await window.showSaveFilePicker();

  await observer.observe(fileHandle);
}

// Observe a directory
async function observeDirectory() {
  const directoryHandle = await window.showDirectoryPicker();

  await observer.observe(directoryHandle);
}

Sie können auch Änderungen am OPFS beobachten, indem Sie ein FileSystemSyncAccessHandle an observe() übergeben:

// Observe an OPFS file system entry
async function observeOPFSFile() {
  const root = await navigator.storage.getDirectory();
  const draftHandle = await root.getFileHandle("draft.txt", { create: true });
  const syncHandle = await draftHandle.createSyncAccessHandle();

  await observer.observe(syncHandle);
}

Um ein Verzeichnis rekursiv zu beobachten, rufen Sie observe() mit der Option recursive auf true gesetzt auf:

// Observe a directory recursively
async function observeDirectory() {
  const directoryHandle = await window.showDirectoryPicker();

  await observer.observe(directoryHandle, { recursive: true });
}

Derzeit nicht Teil einer Spezifikation. Siehe https://github.com/whatwg/fs/pull/165 für den relevanten Spezifikations-PR.

• File System API
• Die Datei-Systembeobachter-API Origin Trial auf developer.chrome.com (2024)