Interface RemoteStoreTransport<K, V>

Provider-neutral transport contract for an async remote store. A transport must declare its actual capabilities; this wrapper never upgrades them.

interface RemoteStoreTransport<K, V> {
    get(key: K): Promise<V | undefined>;
    has(key: K): Promise<boolean>;
    set(key: K, value: V, options?: StoreEntryOptions): Promise<void>;
    delete(key: K): Promise<boolean>;
    clear(): Promise<void>;
    capabilities: StoreCapabilities;
}

Type Parameters

K
V

Hierarchy (View Summary)

AsyncStore<K, V>
- RemoteStoreTransport

Index

Properties

Methods

get has set delete clear

Properties

`Readonly`capabilities

capabilities: StoreCapabilities

Methods

get

get(key: K): Promise<V | undefined>
Parameters
- key: K
Returns Promise<V | undefined>
Inherited from AsyncStore.get
- Defined in src/core/store.ts:29

has

has(key: K): Promise<boolean>
Parameters
- key: K
Returns Promise<boolean>
Inherited from AsyncStore.has
- Defined in src/core/store.ts:30

set

set(key: K, value: V, options?: StoreEntryOptions): Promise<void>
Parameters
- key: K
- value: V
- Optionaloptions: StoreEntryOptions
Returns Promise<void>
Inherited from AsyncStore.set
- Defined in src/core/store.ts:31

delete

delete(key: K): Promise<boolean>
Parameters
- key: K
Returns Promise<boolean>
Inherited from AsyncStore.delete
- Defined in src/core/store.ts:32

clear

clear(): Promise<void>
Returns Promise<void>
Inherited from AsyncStore.clear
- Defined in src/core/store.ts:33