Class StoreIndexedDB

Store implementation for the browser.

Usage:

import { StoreIndexedDB } from '@web3-storage/access/stores/store-indexeddb'

Hierarchy

IndexedDBDriver
- StoreIndexedDB

Index

Constructors

constructor

new StoreIndexedDB(dbName, options?): StoreIndexedDB
Parameters
- dbName: string
- Optional options: {
      autoOpen: undefined | boolean;
      dbStoreName: undefined | string;
      dbVersion: undefined | number;
  } = {}
  - autoOpen: undefined | boolean
  - dbStoreName: undefined | string
  - dbVersion: undefined | number
Returns StoreIndexedDB
Inherited from IndexedDBDriver.constructor
- Defined in packages/access-client/src/drivers/indexeddb.js:46

Properties

`Private` #autoOpen

#autoOpen: boolean

`Private` #db

#db: undefined | IDBDatabase

`Private` #dbName

#dbName: string

`Private` #dbStoreName

#dbStoreName: string

`Private` #dbVersion

#dbVersion: undefined | number

Methods

`Private` #getOpenDB

#getOpenDB(): Promise<IDBDatabase>
Returns Promise<IDBDatabase>
Inherited from IndexedDBDriver.#getOpenDB
- Defined in packages/access-client/src/drivers/indexeddb.js:54

close

close(): Promise<void>
Returns Promise<void>
Inherited from IndexedDBDriver.close
- Defined in packages/access-client/src/drivers/indexeddb.js:86

load

load(): Promise<undefined | AgentDataExport>
Returns Promise<undefined | AgentDataExport>
Inherited from IndexedDBDriver.load
- Defined in packages/access-client/src/drivers/indexeddb.js:118

open

open(): Promise<void>
Returns Promise<void>
Inherited from IndexedDBDriver.open
- Defined in packages/access-client/src/drivers/indexeddb.js:63

reset

reset(): Promise<void>
Returns Promise<void>
Inherited from IndexedDBDriver.reset
- Defined in packages/access-client/src/drivers/indexeddb.js:142

save

save(data): Promise<void>
Parameters
- data: AgentDataExport
Returns Promise<void>
Inherited from IndexedDBDriver.save
- Defined in packages/access-client/src/drivers/indexeddb.js:95

Class StoreIndexedDB

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dbName: string

`Optional` options: {
    autoOpen: undefined | boolean;
    dbStoreName: undefined | string;
    dbVersion: undefined | number;
} = {}

autoOpen: undefined | boolean

dbStoreName: undefined | string

dbVersion: undefined | number

Returns StoreIndexedDB

Properties

`Private` #autoOpen

`Private` #db

`Private` #dbName

`Private` #dbStoreName

`Private` #dbVersion

Methods

`Private` #getOpenDB

Returns Promise<IDBDatabase>

close

Returns Promise<void>

load

Returns Promise<undefined | AgentDataExport>

open

Returns Promise<void>

reset

Returns Promise<void>

save

Parameters

data: AgentDataExport

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Class StoreIndexedDB

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dbName: string

Optional options: { autoOpen: undefined | boolean; dbStoreName: undefined | string; dbVersion: undefined | number; } = {}

autoOpen: undefined | boolean

dbStoreName: undefined | string

dbVersion: undefined | number

Returns StoreIndexedDB

Properties

Private #autoOpen

Private #db

Private #dbName

Private #dbStoreName

Private #dbVersion

Methods

Private #getOpenDB

Returns Promise<IDBDatabase>

close

Returns Promise<void>

load

Returns Promise<undefined | AgentDataExport>

open

Returns Promise<void>

reset

Returns Promise<void>

save

Parameters

data: AgentDataExport

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` options: {
autoOpen: undefined | boolean;
dbStoreName: undefined | string;
dbVersion: undefined | number;
} = {}

`Private` #autoOpen

`Private` #db

`Private` #dbName

`Private` #dbStoreName

`Private` #dbVersion

`Private` #getOpenDB