OpenFairyGUI API
    Preparing search index...

    Interface BackendAsyncStorageAdapter

    interface BackendAsyncStorageAdapter {
        caseSensitivePaths?: boolean;
        acquireSessionLock?(lockPath: string): Promise<BackendSessionLock>;
        dirname?(filePath: string): string;
        exists?(filePath: string): Promise<boolean>;
        join?(...paths: string[]): string;
        mkdir(dirPath: string, options?: { recursive?: boolean }): Promise<void>;
        readdir(dirPath: string): Promise<string[]>;
        readFile(filePath: string): Promise<string>;
        readFileRaw(filePath: string): Promise<Uint8Array<ArrayBufferLike>>;
        resolve?(...paths: string[]): string;
        resolvePath?(filePath: string): Promise<string>;
        rmdir(dirPath: string): Promise<void>;
        stat?(filePath: string): Promise<BackendStorageStatLike>;
        unlink(filePath: string): Promise<void>;
        writeFile(filePath: string, content: string): Promise<void>;
        writeFileRaw(filePath: string, data: Uint8Array): Promise<void>;
    }
    Index
    caseSensitivePaths?
    acquireSessionLock? dirname? exists? join? mkdir readdir readFile readFileRaw resolve? resolvePath? rmdir stat? unlink writeFile writeFileRaw
    caseSensitivePaths?: boolean

    Whether canonical storage paths distinguish case. Defaults to true (including OPFS).

    • Optional replacement for Web Locks. Acquisition must be atomic across browser contexts, remain held until release(), and recover automatically when the owning document terminates.

      Parameters

      • lockPath: string

      Returns Promise<BackendSessionLock>

    • Parameters

      • dirPath: string
      • Optionaloptions: { recursive?: boolean }

      Returns Promise<void>

    • Parameters

      • filePath: string

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Stable cross-context path identity; also scopes the default Web Lock name.

      Parameters

      • filePath: string

      Returns Promise<string>

    • Parameters

      • filePath: string
      • content: string

      Returns Promise<void>

    • Parameters

      • filePath: string
      • data: Uint8Array

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods