OCP App SDK / LocalAsyncStoreBackend

Class: LocalAsyncStoreBackend<T>

Defined in: src/store/LocalAsyncStoreBackend.ts:21

Simulates access to a remote data store by performing operations asynchronously.
Used as a backend for local dev and testing to the local stores

Type Parameters

T

T

Constructors

Constructor

new LocalAsyncStoreBackend<T>(avgDelay, sourceData?, changeHandler?): LocalAsyncStoreBackend<T>

Defined in: src/store/LocalAsyncStoreBackend.ts:29

Parameters

avgDelay

number = 0

Average delay per request in miliseconds

sourceData?

changeHandler?

(data) => Promise<void>

Returns

LocalAsyncStoreBackend<T>

Methods

atomicPatch()

atomicPatch<O>(key, updater): Promise<O>

Defined in: src/store/LocalAsyncStoreBackend.ts:82

Normal KV patch is not atomic without CAS and potentially retries. This implementation
is specifically for operations that are atomic on the data store side, such as mutating a list.

Type Parameters

O

O

Parameters

key

string

to update

updater

PatchUpdater<O>

callback to perform atomic update

Returns

Promise<O>

delete()

delete<O>(key): Promise<O>

Defined in: src/store/LocalAsyncStoreBackend.ts:111

Type Parameters

O

O

Parameters

key

string

Returns

Promise<O>

exists()

exists(key): Promise<boolean>

Defined in: src/store/LocalAsyncStoreBackend.ts:123

Parameters

key

string

Returns

Promise<boolean>

get()

get<O>(key): Promise<StoreEntry<O>>

Defined in: src/store/LocalAsyncStoreBackend.ts:37

Type Parameters

O

O

Parameters

key

string

Returns

Promise<StoreEntry<O>>

put()

put<O>(key, value, ttl?, cas?): Promise<O>

Defined in: src/store/LocalAsyncStoreBackend.ts:48

Type Parameters

O

O

Parameters

key

string

value

O

ttl?

number

cas?

number

Returns

Promise<O>

reset()

reset(): void

Defined in: src/store/LocalAsyncStoreBackend.ts:130

Returns

void