IndexedDbStorageAdapter | virgil-sdk

Implementation of IStorageAdapter that uses IndexedDB for persistence. For use in browsers.

Hierarchy

IndexedDbStorageAdapter

Implements

IStorageAdapter

Index

Constructors

constructor

Methods

Constructors

constructor

new IndexedDbStorageAdapter(config: IStorageAdapterConfig): IndexedDbStorageAdapter

- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:47
Initializes an instance of IndexedDbStorageAdapter.

Parameters
- config: IStorageAdapterConfig
  
  Configuration options. Currently only name is supported and must be the name of the IndexedDB database where the data will be stored.
Returns IndexedDbStorageAdapter

Methods

clear

clear(): Promise<void>

Implementation of IStorageAdapter.clear
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:258
Removes all of the entries from persistent storage.

Returns Promise<void>

exists

exists(key: string): Promise<boolean>

Implementation of IStorageAdapter.exists
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:147
Checks if the data for the key exists.

Parameters
- key: string
Returns Promise<boolean>
- Promise resolved with true if data for the key exists, or false otherwise.

list

list(): Promise<string[]>

Implementation of IStorageAdapter.list
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:289
Retrieves a collection of all of the values in persistent storage.

Returns Promise<string[]>

load

load(key: string): Promise<string | null>

Implementation of IStorageAdapter.load
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:112
Retieves the data for the key.

Parameters
- key: string
Returns Promise<string | null>
- Promise resolved with the data for the given key, or null if there's no data.

remove

remove(key: string): Promise<boolean>

Implementation of IStorageAdapter.remove
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:179
Removes the data for the key.

Parameters
- key: string
Returns Promise<boolean>

Promise resolved with true if data have been removed, or false otherwise.

store

store(key: string, data: string): Promise<void>

Implementation of IStorageAdapter.store
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:72
Saves the data under the key in persistent storage. If the key already exists, throws StorageEntryAlreadyExistsError.

Parameters
- key: string
- data: string
Returns Promise<void>

update

update(key: string, data: string): Promise<void>

Implementation of IStorageAdapter.update
- Defined in Storage/adapters/IndexedDbStorageAdapter.ts:227
Sets the new data for the key.

Parameters
- key: string
- data: string
Returns Promise<void>