FileSystemHandle: remove() Methode

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

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.

Die remove()-Methode der FileSystemHandle-Schnittstelle fordert die Entfernung des durch den Handle dargestellten Eintrags aus dem zugrunde liegenden Dateisystem an.

Die remove()-Methode ermöglicht Ihnen, eine Datei oder ein Verzeichnis direkt über dessen Handle zu entfernen. Ohne diese Methode müssten Sie den Handle des übergeordneten Verzeichnisses erhalten und dann FileSystemDirectoryHandle.removeEntry() darauf aufrufen, um sie zu entfernen.

Sie können remove() auch auf das Stammverzeichnis des Origin Private File System aufrufen, um dessen Inhalte zu löschen, wonach ein neues, leeres OPFS erstellt wird.

Syntax

remove()
remove(options)

Parameter

options Optional

Ein Objekt, das Optionen für die Entfernung angibt. Mögliche Eigenschaften sind wie folgt:

recursive Optional: Ein boolescher Wert, der standardmäßig auf false gesetzt ist. Wenn auf true gesetzt und der Eintrag ein Verzeichnis ist, werden seine Inhalte rekursiv entfernt.

Rückgabewert

Ein Promise, das mit einem Wert von undefined erfüllt wird.

Ausnahmen

InvalidModificationError DOMException: Wird ausgelöst, wenn recursive auf false gesetzt ist und der zu entfernende Eintrag ein Verzeichnis mit Untereinträgen ist.
NoModificationAllowedError DOMException: Wird ausgelöst, wenn der Browser keinen exklusiven Zugriff auf den Eintrag erhalten konnte.
NotAllowedError DOMException: Wird ausgelöst, wenn PermissionStatus nicht gewährt ist.
NotFoundError DOMException: Wird ausgelöst, wenn der Eintrag nicht gefunden wird.

Beispiele

Unser FileSystemHandle.remove()-Demo (siehe den Quellcode) ist eine Datei-Ersteller-App. Sie können Text in den <textarea> eingeben und die "Datei speichern"-<button> drücken. Die App öffnet dann einen Dateiwähler, mit dem Sie diesen Text in einer Textdatei Ihrer Wahl auf Ihrem lokalen Dateisystem speichern können. Sie können auch die erstellten Dateien löschen.

Es ist nicht möglich, den Inhalt der erstellten Dateien anzuzeigen, und die App synchronisiert sich nicht mit dem zugrunde liegenden Dateisystem bei Seitenneuladen- oder -schließen. Das bedeutet, dass von der App erstellte Dateien weiterhin im Dateisystem existieren, wenn Sie sie nicht vor dem Neuladen oder Schließen der Registerkarte löschen.

Der Dateiwähler, der Dateihandle und die Datei selbst, falls Sie eine neue Datei erstellen, werden mit window.showSaveFilePicker() erstellt. Der Text wird über FileSystemFileHandle.createWritable() in die Datei geschrieben.

Sobald eine Datei im Dateisystem erstellt wird, wird in der App ein Eintrag erstellt (siehe processNewFile() im Quellcode):

Eine Referenz zum Dateihandle wird in einem Array namens savedFileRefs gespeichert, sodass sie später einfach referenziert werden kann.
Ein Listeneintrag wird unter der Überschrift "Gespeicherte Dateien" in der Benutzeroberfläche hinzugefügt, wobei der Dateiname zusammen mit einem "Löschen"-Button angezeigt wird.

Wenn der "Löschen"-Button gedrückt wird, wird die deleteFile()-Funktion ausgeführt, die wie folgt aussieht:

async function deleteFile(e) {
  for (const handle of savedFileRefs) {
    if (handle.name === `${e.target.id}.txt`) {
      await handle.remove();
      savedFileRefs = savedFileRefs.filter(
        (handle) => handle.name !== `${e.target.id}.txt`,
      );
      e.target.parentElement.parentElement.removeChild(e.target.parentElement);
    }
  }
}

Ein Durchlauf durch diese Schritte:

Für jeden in dem savedFileRefs-Array gespeicherten Dateihandle überprüfen wir dessen Namen, um zu sehen, ob er mit dem id-Attribut des Buttons übereinstimmt, der das Ereignis ausgelöst hat.
Wenn eine Übereinstimmung gefunden wird, führen wir FileSystemHandle.remove() auf diesem Handle aus, um die Datei aus dem zugrunde liegenden Dateisystem zu entfernen.
Wir entfernen auch den übereinstimmenden Handle aus dem savedFileRefs-Array.
Schließlich entfernen wir den zu dieser Datei gehörenden Listeneintrag in der Benutzeroberfläche.

Dateisystem-API