IStorageAdapter | virgil-sdk

Interface to be implemented by objects capable of storing binary data in persistent storage.

Hierarchy

IStorageAdapter

Implemented by

Index

Methods

Methods

clear

clear(): Promise<void>

- Defined in Storage/adapters/IStorageAdapter.ts:59
Removes all of the entries from persistent storage.

Returns Promise<void>

exists

exists(key: string): Promise<boolean>

- Defined in Storage/adapters/IStorageAdapter.ts:38
Checks if the data for the key exists.

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

list

list(): Promise<string[]>

- Defined in Storage/adapters/IStorageAdapter.ts:65
Retrieves a collection of all of the values in persistent storage.

Returns Promise<string[]>

load

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

- Defined in Storage/adapters/IStorageAdapter.ts:30
Retieves the data for the key.

Parameters
- key: string
  
  The key.
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>

- Defined in Storage/adapters/IStorageAdapter.ts:46
Removes the data for the key.

Parameters
- key: string
  
  The key to remove.
Returns Promise<boolean>

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

store

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

- Defined in Storage/adapters/IStorageAdapter.ts:22
Saves the data under the key in persistent storage. If the key already exists, throws StorageEntryAlreadyExistsError.

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

update

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

- Defined in Storage/adapters/IStorageAdapter.ts:53
Sets the new data for the key.

Parameters
- key: string
  
  The key to update.
- data: string
  
  The new data.
Returns Promise<void>