Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface FakeOpfsDatasetDir

    The flat in-memory dataset directory createFakeOpfsRoot builds by default.

    interface FakeOpfsDatasetDir {
        kind: "directory";
        name: string;
        getFileHandle: (...args: any[]) => Promise<any>;
        getDirectoryHandle: (...args: any[]) => Promise<any>;
        removeEntry: (...args: any[]) => Promise<void>;
        keys: () => AsyncGenerator<string>;
        entries: () => AsyncGenerator<[string, any]>;
        clear: () => void;
    }
    Index
    kind: "directory"
    name: string
    getFileHandle: (...args: any[]) => Promise<any>

    (name, { create? }) — loosely typed so tests can wrap it with (...args).

    getDirectoryHandle: (...args: any[]) => Promise<any>

    (bucket, { create? }) — every bucket resolves to the dataset dir itself.

    removeEntry: (...args: any[]) => Promise<void>

    (name, { recursive? }) — NotFoundError for an absent file.

    keys: () => AsyncGenerator<string>
    entries: () => AsyncGenerator<[string, any]>
    clear: () => void

    Wipe every file (what removing the dataset directory does).