FileSystemDirectoryHandle: Methode getFileHandle()

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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.

Die getFileHandle() Methode der FileSystemDirectoryHandle-Schnittstelle gibt ein FileSystemFileHandle für eine Datei mit dem angegebenen Namen innerhalb des Verzeichnisses zurück, in dem die Methode aufgerufen wird.

Syntax

js
getFileHandle(name)
getFileHandle(name, options)

Parameter

name

Ein String, der den FileSystemHandle.name der Datei repräsentiert, die Sie abrufen möchten.

options Optional

Ein Objekt mit den folgenden Eigenschaften:

create Optional

Ein Boolean. Standardmäßig false. Wenn auf true gesetzt, wird eine Datei mit dem angegebenen Namen erstellt und zurückgegeben, falls die Datei nicht gefunden wird.

Rückgabewert

Ein Promise, das mit einem FileSystemFileHandle aufgelöst wird.

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn der PermissionStatus.state für den Handle nicht 'granted' im readwrite-Modus ist, wenn die create-Option auf true gesetzt ist, oder im read-Modus, wenn die create-Option auf false gesetzt ist.

TypeError

Wird ausgelöst, wenn der angegebene Name kein gültiger String ist oder Zeichen enthält, die das native Dateisystem stören würden.

TypeMismatchError DOMException

Wird ausgelöst, wenn der benannte Eintrag ein Verzeichnis und keine Datei ist.

NotFoundError DOMException

Wird ausgelöst, wenn der aktuelle Eintrag nicht gefunden wird oder wenn die Datei nicht existiert und die create-Option auf false gesetzt ist.

Beispiele

Das folgende Beispiel gibt einen Datei-Handle mit dem angegebenen Namen zurück; falls die Datei nicht existiert, wird sie erstellt.

js
const fileName = "fileToGetName";

// assuming we have a directory handle: 'currentDirHandle'
const fileHandle = currentDirHandle.getFileHandle(fileName, { create: true });

Spezifikationen

Specification
File System Standard
# api-filesystemdirectoryhandle-getfilehandle

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch