Interface IStorageProvider<TKey, TValue>

Represents a key/value storage system

Type parameters

TKey
TValue

Hierarchy

IStorageProvider
- ISubscribableStorageProvider

Implemented by

Index

Properties

isPersistable

Methods

Properties

Readonly isPersistable

isPersistable: boolean

returns: If this storage layer can be used for permenant storage

Methods

delete

delete(key: TKey): Promise<boolean | IAgedValue<TValue>>

- Defined in main/src/storage/IStorageProvider.ts:30
Parameters
- key: TKey
  
  The key to the value to delete
Returns Promise<boolean | IAgedValue<TValue>>
The value deleted or boolean (value | true is success). A provider is not required to return a value

get

get(key: TKey): Promise<null | IAgedValue<TValue>>

- Defined in main/src/storage/IStorageProvider.ts:16
Parameters
- key: TKey
  
  The key to retrieve
Returns Promise<null | IAgedValue<TValue>>
The value if retreiving was successful or null

keys

keys(): Promise<TKey[]>

- Defined in main/src/storage/IStorageProvider.ts:35
Returns Promise<TKey[]>
The keys that are currently available in the provider

set

set(key: TKey, value: IAgedValue<TValue>): Promise<null | IAgedValue<TValue>>

- Defined in main/src/storage/IStorageProvider.ts:23
Parameters
- key: TKey
  
  The key to set
- value: IAgedValue<TValue>
  
  The value to set
Returns Promise<null | IAgedValue<TValue>>
The value written if successful or null

size

size(): Promise<number>

- Defined in main/src/storage/IStorageProvider.ts:40
Returns Promise<number>
The number of elements in this storage system

Generated using TypeDoc