Interface KeyValuePersistence<T>

An abstract persistence interface for an async key / value store.

interface KeyValuePersistence<T> {
    clear(): Promise<void>;
    get(key: string): Promise<null | T>;
    remove(key: string): Promise<void>;
    set(key: string, value: T): Promise<void>;
}

Type Parameters

T

Implemented by

StoragePersistence

Index

Methods

clear get remove set

Methods

clear

clear(): Promise<void>
Clears all items.

Returns Promise<void>
- Defined in persistence/KeyValuePersistence.ts:33

get

get(key: string): Promise<null | T>
Resolves to the value for the given key, or null if non-existent.
Parameters
- key: string
Returns Promise<null | T>
- Defined in persistence/KeyValuePersistence.ts:13

remove

remove(key: string): Promise<void>
Removes the given key.
Parameters
- key: string
Returns Promise<void>
- Defined in persistence/KeyValuePersistence.ts:28

set

set(key: string, value: T): Promise<void>
Saves the given value to disk.
Parameters
- key: string
- value: T
Returns Promise<void>
- Defined in persistence/KeyValuePersistence.ts:21