Interface: CacheStore

nekte-protocol

---

nekte-protocol / client/src / CacheStore

Interface: CacheStore

Defined in: nekte-source/packages/client/src/cache-store.ts:42

Port: backing store for cache entries. Implement this to use Redis, shared memory, etc.

Properties

size

readonly size: number

Defined in: nekte-source/packages/client/src/cache-store.ts:51

Methods

clear()

clear(): void

Defined in: nekte-source/packages/client/src/cache-store.ts:52

Returns

void

---

delete()

delete(key): boolean

Defined in: nekte-source/packages/client/src/cache-store.ts:49

Parameters

key

string

Returns

boolean

---

get()

get(key): CacheGetResult | undefined

Defined in: nekte-source/packages/client/src/cache-store.ts:47

Get an entry. Returns undefined if not found or fully expired. Returns { entry, freshness } where freshness indicates TTL state.

Parameters

key

string

Returns

CacheGetResult | undefined

---

keys()

keys(): IterableIterator<string>

Defined in: nekte-source/packages/client/src/cache-store.ts:50

Returns

IterableIterator<string>

---

set()

set(key, entry): void

Defined in: nekte-source/packages/client/src/cache-store.ts:48

Parameters

key

string

entry

CacheStoreEntry

Returns

void