Class IndexedDBStorage

Internalapi

The storage used in the SDK

Hierarchy

Storage
- IndexedDBStorage

Index

Constructors

constructor

new IndexedDBStorage(dbName?, storeName?): IndexedDBStorage
Parameters
- dbName: string = 'WALLET_CONNECT_V2_INDEXED_DB'
- storeName: string = 'keyvaluestorage'
Returns IndexedDBStorage
Overrides Storage.constructor
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:10

Properties

`Private` db

db: null | IDBDatabase = null

`Private` `Readonly` dbName

dbName: string = 'WALLET_CONNECT_V2_INDEXED_DB'

`Private` isSupported

isSupported: boolean = true

`Private` `Readonly` storeName

storeName: string = 'keyvaluestorage'

Methods

clearStore

clearStore(): Promise<void>
Returns Promise<void>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:129

delete

delete<K>(key): Promise<void>
Delete a key from storage
Type Parameters
- K extends StorageKey
Parameters
- key: K
  
  The storage key
Returns Promise<void>
Overrides Storage.delete
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:93

fillStore

fillStore(targetDBName, targetStoreName, skipKeys?): Promise<void>
it copies over all key value pairs from a source store into a target one
Parameters
- targetDBName: string
  
  the name of the target DB
- targetStoreName: string
  
  the name of the target store
- skipKeys: string[] = []
  
  all the keys to ignore
Returns Promise<void>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:164

get

get<K>(key): Promise<StorageKeyReturnType[K]>
Gets a value from storage and returns it
Type Parameters
- K extends StorageKey
Parameters
- key: K
  
  The storage key
Returns Promise<StorageKeyReturnType[K]>
Overrides Storage.get
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:69

getAll

getAll(): Promise<string[]>
Returns Promise<string[]>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:105

getAllKeys

getAllKeys(): Promise<IDBValidKey[]>
Returns Promise<IDBValidKey[]>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:117

getPrefixedKey

getPrefixedKey<K>(key): string
Get the key with the internal prefix
Type Parameters
- K extends StorageKey
Parameters
- key: K
  
  the storage key
Returns string
Overrides Storage.getPrefixedKey
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:141

`Private` initDB

initDB(): Promise<IDBDatabase>
Returns Promise<IDBDatabase>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:30

`Private` isIndexedDBSupported

isIndexedDBSupported(): boolean
Returns boolean
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:20

set

set<K>(key, value): Promise<void>
Sets a value in the storage and persist it
Type Parameters
- K extends StorageKey
Parameters
- key: K
  
  The storage key
- value: StorageKeyReturnType[K]
  
  The value to be persisted
Returns Promise<void>
Overrides Storage.set
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:81

subscribeToStorageChanged

subscribeToStorageChanged(callback): Promise<void>
This event will fire if the storage was modified by someone else, eg. on another tab
Parameters
- callback: ((arg) => {})
  
  The callback to be called when a storage value changes
  - - (arg): {}
    - Parameters
      
      arg: {
          eventType: "storageCleared" | "entryModified";
          key: null | string;
          newValue: null | string;
          oldValue: null | string;
      }
      
      eventType: "storageCleared" | "entryModified"
      
      key: null | string
      
      newValue: null | string
      
      oldValue: null | string
      
      Returns {}
Returns Promise<void>
Overrides Storage.subscribeToStorageChanged
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:146

`Private` transaction

transaction<T>(mode, operation): Promise<T>
Type Parameters
- T
Parameters
- mode: IDBTransactionMode
- operation: ((store) => Promise<T>)
  - - (store): Promise<T>
    - Parameters
      
      store: IDBObjectStore
      
      Returns Promise<T>
Returns Promise<T>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:50

`Static` isSupported

isSupported(): Promise<boolean>
Returns a promise that resolves to true if the storage option is available on this platform.

Returns Promise<boolean>
Inherited from Storage.isSupported
- Defined in beacon-types/dist/esm/types/storage/Storage.d.ts:11

Class IndexedDBStorage

Internalapi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dbName: string = 'WALLET_CONNECT_V2_INDEXED_DB'

storeName: string = 'keyvaluestorage'

Returns IndexedDBStorage

Properties

Private db

Private Readonly dbName

Private isSupported

Private Readonly storeName

Methods

clearStore

Returns Promise<void>

delete

Type Parameters

K extends StorageKey

Parameters

key: K

Returns Promise<void>

fillStore

Parameters

targetDBName: string

targetStoreName: string

skipKeys: string[] = []

Returns Promise<void>

get

Type Parameters

K extends StorageKey

Parameters

key: K

Returns Promise<StorageKeyReturnType[K]>

getAll

Returns Promise<string[]>

getAllKeys

Returns Promise<IDBValidKey[]>

getPrefixedKey

Type Parameters

K extends StorageKey

Parameters

key: K

Returns string

Private initDB

Returns Promise<IDBDatabase>

Private isIndexedDBSupported

Returns boolean

set

Type Parameters

K extends StorageKey

Parameters

key: K

value: StorageKeyReturnType[K]

Returns Promise<void>

subscribeToStorageChanged

Parameters

callback: ((arg) => {})

Parameters

arg: { eventType: "storageCleared" | "entryModified"; key: null | string; newValue: null | string; oldValue: null | string; }

eventType: "storageCleared" | "entryModified"

key: null | string

newValue: null | string

oldValue: null | string

Returns {}

Returns Promise<void>

Private transaction

Type Parameters

T

Parameters

mode: IDBTransactionMode

operation: ((store) => Promise<T>)

Parameters

store: IDBObjectStore

Returns Promise<T>

`Private` db

`Private` `Readonly` dbName

`Private` isSupported

`Private` `Readonly` storeName

`Private` initDB

`Private` isIndexedDBSupported

arg: {
eventType: "storageCleared" | "entryModified";
key: null | string;
newValue: null | string;
oldValue: null | string;
}

`Private` transaction

`Static` isSupported