Class: NodeCache

Defined in: packages/minerender/src/env/node/NodeCache.ts:10

PersistentCache backed by node-persist (one directory of JSON files per cache).

node-persist requires an explicit init() before any read or write; that is done lazily on first access so that merely constructing the cache stays free of filesystem side effects.

Extends

• PersistentCache<LocalStorage>

Constructors

Constructor

new NodeCache(backing): NodeCache;

Defined in: packages/minerender/src/env/node/NodeCache.ts:14

Parameters

Parameter	Type
backing	LocalStorage

Returns

NodeCache

Overrides

PersistentCache<LocalStorage>.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
backing	readonly	LocalStorage	undefined	-	PersistentCache.backing	packages/minerender/src/cache/PersistentCache.ts:19
VERSION	readonly	2	2	Bump to invalidate every persisted entry.	PersistentCache.VERSION	packages/minerender/src/cache/PersistentCache.ts:13

Methods

clear()

clear(): Promise<void>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:37

Returns

Promise<void>

Overrides

PersistentCache.clear

---

delete()

delete<T>(key): Promise<void>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:32

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string

Returns

Promise<void>

Overrides

PersistentCache.delete

---

forEach()

forEach<T>(callback): Promise<void>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:52

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
callback	(v, k) => void

Returns

Promise<void>

Overrides

PersistentCache.forEach

---

get()

get<T>(key): Promise<T>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:22

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string

Returns

Promise<T>

Overrides

PersistentCache.get

---

getOrLoad()

getOrLoad<T>(key, loader): Promise<T>;

Defined in: packages/minerender/src/cache/PersistentCache.ts:25

Loads a missing entry and stores only non-nullish results.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
loader	(key) => Promise<T>

Returns

Promise<T>

Inherited from

PersistentCache.getOrLoad

---

keys()

keys(): Promise<string[]>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:47

Returns

Promise<string[]>

Overrides

PersistentCache.keys

---

length()

length(): Promise<number>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:42

Returns

Promise<number>

Overrides

PersistentCache.length

---

put()

put<T>(key, value): Promise<T>;

Defined in: packages/minerender/src/env/node/NodeCache.ts:27

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
value	T

Returns

Promise<T>

Overrides

PersistentCache.put

---

open()

static open(name): PersistentCache;

Defined in: packages/minerender/src/cache/PersistentCache.ts:15

Parameters

Parameter	Type
name	string

Returns

PersistentCache

Inherited from

PersistentCache.open