@loontail/minecraft-kit / MetadataCache

Type Alias: MetadataCache

type MetadataCache = {
  clear: void;
  delete: void;
  get: T | undefined;
  set: void;
};

Defined in: src/types/cache.ts:5

Pluggable in-memory cache for HTTP metadata responses. Default implementation: createMemoryCache. Implement this to back the cache by Redis, disk, etc.

Methods

clear()

clear(): void;

Defined in: src/types/cache.ts:9

Returns

void

---

delete()

delete(key): void;

Defined in: src/types/cache.ts:8

Parameters

Parameter	Type
key	string

Returns

void

---

get()

get<T>(key): T | undefined;

Defined in: src/types/cache.ts:6

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string

Returns

T | undefined

---

set()

set<T>(
   key, 
   value, 
   ttlMs?): void;

Defined in: src/types/cache.ts:7

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
value	T
ttlMs?	number

Returns

void