TypeScript API / laikacms/storage/web-fs / WebFsDirectoryHandle

Interface: WebFsDirectoryHandle

Structural subset of FileSystemDirectoryHandle.

Properties

kind

readonly kind: "directory";

---

name

readonly name: string;

Methods

entries()

entries(): AsyncIterable<[string, WebFsFileHandle | WebFsDirectoryHandle]>;

Returns

AsyncIterable<[string, WebFsFileHandle | WebFsDirectoryHandle]>

---

getDirectoryHandle()

getDirectoryHandle(name, options?): Promise<WebFsDirectoryHandle>;

Parameters

Parameter	Type
name	string
options?	{ create?: boolean; }
options.create?	boolean

Returns

Promise<WebFsDirectoryHandle>

---

getFileHandle()

getFileHandle(name, options?): Promise<WebFsFileHandle>;

Parameters

Parameter	Type
name	string
options?	{ create?: boolean; }
options.create?	boolean

Returns

Promise<WebFsFileHandle>

---

queryPermission()?

optional queryPermission(descriptor): Promise<WebFsPermissionState>;

Present on user-picked handles (showDirectoryPicker()) in Chromium; typically absent on origin-private handles and in engines that don't ship the WICG permission surface (it is also absent from lib.dom, hence optional-structural). Absence is treated as 'granted' — a handle that cannot be asked about permission cannot have lost it.

Parameters

Parameter	Type
descriptor	{ mode: WebFsAccessMode; }
descriptor.mode	WebFsAccessMode

Returns

Promise<WebFsPermissionState>

---

removeEntry()

removeEntry(name, options?): Promise<void>;

Parameters

Parameter	Type
name	string
options?	{ recursive?: boolean; }
options.recursive?	boolean

Returns

Promise<void>