Class IndexedDBStorage

Internalapi

The storage used in the SDK

Hierarchy (View Summary)

Storage
- IndexedDBStorage

Index

Constructors

constructor

Methods

clearStore delete fillStore get getAll getAllKeys getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

new IndexedDBStorage(dbName?: string, storeNames?: string[]): IndexedDBStorage
Parameters
- dbName: string = 'WALLET_CONNECT_V2_INDEXED_DB'
  Name of the database.
- storeNames: string[] = ...
  An array of object store names to create in the database. The first store in the array will be used as the default if none is specified.
Returns IndexedDBStorage
Overrides Storage.constructor
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:15

Methods

clearStore

clearStore(storeName?: string): Promise<void>
Clears all entries from the specified object store.
Parameters
- OptionalstoreName: string
Returns Promise<void>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:217

delete

delete<K extends StorageKey>(key: K, storeName?: string): Promise<void>
Deletes an entry by key from the specified object store.
Type Parameters
- K extends StorageKey
Parameters
- key: K
- OptionalstoreName: string
Returns Promise<void>
Overrides Storage.delete
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:167
delete(key: string, storeName?: string): Promise<void>
Deletes an entry by key from the specified object store.
Parameters
- key: string
- OptionalstoreName: string
Returns Promise<void>
Overrides Storage.delete
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:168

fillStore

fillStore(
    targetDBName: string,
    targetStoreName: string,
    skipKeys?: string[],
    sourceStoreName?: string,
): Promise<void>
Copies all key/value pairs from the source store into a target store.
Parameters
- targetDBName: string
  Name of the target database.
- targetStoreName: string
  Name of the target object store.
- skipKeys: string[] = []
  Keys to skip.
- sourceStoreName: string = ...
  (Optional) Source store name – defaults to the default store.
Returns Promise<void>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:254

get

get<K extends StorageKey>(
key: K,
storeName?: string,
): Promise<StorageKeyReturnType[K]>
Retrieves a value by key from the specified object store. If no store is specified, the default (first in the list) is used.
Type Parameters
- K extends StorageKey
Parameters
- key: K
- OptionalstoreName: string
Returns Promise<StorageKeyReturnType[K]>
Overrides Storage.get
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:123
get(key: string, storeName?: string): Promise<undefined | string>
Retrieves a value by key from the specified object store. If no store is specified, the default (first in the list) is used.
Parameters
- key: string
- OptionalstoreName: string
Returns Promise<undefined | string>
Overrides Storage.get
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:124

getAll

getAll(storeName?: string): Promise<string[]>
Retrieves all values from the specified object store.
Parameters
- OptionalstoreName: string
Returns Promise<string[]>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:185

getAllKeys

getAllKeys(storeName?: string): Promise<IDBValidKey[]>
Retrieves all keys from the specified object store.
Parameters
- OptionalstoreName: string
Returns Promise<IDBValidKey[]>
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:201

getPrefixedKey

getPrefixedKey<K extends StorageKey>(key: K): 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:230

set

set<K extends StorageKey>(
    key: K,
    value: StorageKeyReturnType[K],
    storeName?: string,
): Promise<void>
Stores a key/value pair in the specified object store.
Type Parameters
- K extends StorageKey
Parameters
- key: K
- value: StorageKeyReturnType[K]
- OptionalstoreName: string
Returns Promise<void>
Overrides Storage.set
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:141
set(key: string, value: string, storeName?: string): Promise<void>
Stores a key/value pair in the specified object store.
Parameters
- key: string
- value: string
- OptionalstoreName: string
Returns Promise<void>
Overrides Storage.set
- Defined in beacon-core/src/storage/IndexedDBStorage.ts:146

subscribeToStorageChanged

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

`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 (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns IndexedDBStorage

Methods

clearStore

Parameters

Returns Promise<void>

delete

Type Parameters

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

fillStore

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<StorageKeyReturnType[K]>

Parameters

Returns Promise<undefined | string>

getAll

Parameters

Returns Promise<string[]>

getAllKeys

Parameters

Returns Promise<IDBValidKey[]>

getPrefixedKey

Type Parameters

Parameters

Returns string

set

Type Parameters

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

subscribeToStorageChanged

Parameters

Returns Promise<void>

StaticisSupported

Returns Promise<boolean>

Settings

On This Page

`Static`isSupported