Variable IndexedDBConst

Type declaration

• Readonly name: "IndexedDB"

• Readonly options: {
      idbFactory: {
          description: "The IDBFactory to use. Defaults to globalThis.indexedDB.";
          required: false;
          type: "object";
      };
      storeName: {
          description: "The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name.";
          required: false;
          type: "string";
      };
  }

  • Readonly idbFactory: {
        description: "The IDBFactory to use. Defaults to globalThis.indexedDB.";
        required: false;
        type: "object";
    }

    • Readonly description: "The IDBFactory to use. Defaults to globalThis.indexedDB."

    • Readonly required: false

    • Readonly type: "object"

  • Readonly storeName: {
        description: "The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name.";
        required: false;
        type: "string";
    }

    • Readonly description: "The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name."

    • Readonly required: false

    • Readonly type: "string"

• create:function

  • create(options): Promise<{
        _sync?: FileSystem;
        createFileSync(path, flag, mode, cred): File;
        linkSync(srcpath, dstpath, cred): void;
        mkdirSync(path, mode, cred): void;
        openFileSync(path, flag, cred): File;
        queueDone(): Promise<void>;
        readdirSync(path, cred): string[];
        ready(): Promise<void>;
        renameSync(oldPath, newPath, cred): void;
        rmdirSync(path, cred): void;
        statSync(path, cred): Stats;
        syncSync(path, data, stats): void;
        unlinkSync(path, cred): void;
    } & StoreFS<IndexedDBStore>>

  • Parameters

    • options: IndexedDBOptions & Partial<SharedConfig>

    Returns Promise<{
        _sync?: FileSystem;
        createFileSync(path, flag, mode, cred): File;
        linkSync(srcpath, dstpath, cred): void;
        mkdirSync(path, mode, cred): void;
        openFileSync(path, flag, cred): File;
        queueDone(): Promise<void>;
        readdirSync(path, cred): string[];
        ready(): Promise<void>;
        renameSync(oldPath, newPath, cred): void;
        rmdirSync(path, cred): void;
        statSync(path, cred): Stats;
        syncSync(path, data, stats): void;
        unlinkSync(path, cred): void;
    } & StoreFS<IndexedDBStore>>

• isAvailable:function

  • isAvailable(idbFactory?): Promise<boolean>

  • Parameters

    • idbFactory: IDBFactory = globalThis.indexedDB

    Returns Promise<boolean>