@nextcloud/dialogs
    Preparing search index...

    Interface FileSystemDirectoryHandle

    The FileSystemDirectoryHandle interface of the File System API provides a handle to a file system directory. Available only in secure contexts.

    MDN Reference

    interface FileSystemDirectoryHandle {
        kind: "directory";
        name: string;
        "[asyncIterator]"(): FileSystemDirectoryHandleAsyncIterator<
            [string, FileSystemDirectoryHandle | FileSystemFileHandle],
        >;
        entries(): FileSystemDirectoryHandleAsyncIterator<
            [string, FileSystemDirectoryHandle | FileSystemFileHandle],
        >;
        getDirectoryHandle(
            name: string,
            options?: FileSystemGetDirectoryOptions,
        ): Promise<FileSystemDirectoryHandle>;
        getFileHandle(
            name: string,
            options?: FileSystemGetFileOptions,
        ): Promise<FileSystemFileHandle>;
        isSameEntry(other: FileSystemHandle): Promise<boolean>;
        keys(): FileSystemDirectoryHandleAsyncIterator<string>;
        removeEntry(name: string, options?: FileSystemRemoveOptions): Promise<void>;
        resolve(possibleDescendant: FileSystemHandle): Promise<string[] | null>;
        values(): FileSystemDirectoryHandleAsyncIterator<
            FileSystemDirectoryHandle
            | FileSystemFileHandle,
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    kind name

    Methods

    [asyncIterator] entries getDirectoryHandle getFileHandle isSameEntry keys removeEntry resolve values

    Properties

    kind: "directory"

    The kind read-only property of the FileSystemHandle interface returns the type of entry. This is 'file' if the associated entry is a file or 'directory'. It is used to distinguish files from directories when iterating over the contents of a directory.

    MDN Reference

    name: string

    The name read-only property of the FileSystemHandle interface returns the name of the entry represented by handle.

    MDN Reference

    Methods

    • The isSameEntry() method of the FileSystemHandle interface compares two handles to see if the associated entries (either a file or directory) match.

      MDN Reference

      Parameters

      Returns Promise<boolean>

    • The removeEntry() method of the FileSystemDirectoryHandle interface attempts to remove an entry if the directory handle contains a file or directory called the name specified.

      MDN Reference

      Parameters

      Returns Promise<void>

    • The resolve() method of the FileSystemDirectoryHandle interface returns an Array of directory names from the parent handle to the specified child entry, with the name of the child entry as the last array item.

      MDN Reference

      Parameters

      Returns Promise<string[] | null>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods