Abstract Class: PersistentCache<B>
Defined in: packages/minerender/src/cache/PersistentCache.ts:10
Key/value store that survives a page reload or process restart.
The concrete backing store is supplied by the active EnvProvider - localforage (IndexedDB) in the browser, node-persist (disk) under Node - so this file itself stays free of any platform-specific import.
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
B | unknown |
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
backing | readonly | B | undefined | - | packages/minerender/src/cache/PersistentCache.ts:20 |
VERSION | readonly | 2 | 2 | Bump to invalidate every persisted entry. | packages/minerender/src/cache/PersistentCache.ts:13 |
Methods
clear()
abstract clear(): Promise<void>;Defined in: packages/minerender/src/cache/PersistentCache.ts:41
Returns
Promise<void>
delete()
abstract delete<T>(key): Promise<void>;Defined in: packages/minerender/src/cache/PersistentCache.ts:39
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<void>
forEach()
abstract forEach<T>(callback): Promise<void>;Defined in: packages/minerender/src/cache/PersistentCache.ts:47
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
callback | (v, k) => void |
Returns
Promise<void>
get()
abstract get<T>(key): Promise<T>;Defined in: packages/minerender/src/cache/PersistentCache.ts:23
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<T>
getOrLoad()
getOrLoad<T>(key, loader): Promise<T>;Defined in: packages/minerender/src/cache/PersistentCache.ts:26
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>
keys()
abstract keys(): Promise<string[]>;Defined in: packages/minerender/src/cache/PersistentCache.ts:45
Returns
Promise<string[]>
length()
abstract length(): Promise<number>;Defined in: packages/minerender/src/cache/PersistentCache.ts:43
Returns
Promise<number>
put()
abstract put<T>(key, value): Promise<T>;Defined in: packages/minerender/src/cache/PersistentCache.ts:37
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
value | T |
Returns
Promise<T>
open()
static open(name): PersistentCache;Defined in: packages/minerender/src/cache/PersistentCache.ts:16
Opens a named store in the active environment using the current cache schema version.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
PersistentCache