Skip to content

Class: BrowserCache ​

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:6

PersistentCache backed by localforage (IndexedDB / WebSQL / localStorage).

Extends ​

Constructors ​

Constructor ​

ts
new BrowserCache(backing): BrowserCache;

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:8

Parameters ​

ParameterType
backingLocalForage

Returns ​

BrowserCache

Overrides ​

ts
PersistentCache<LocalForage>.constructor

Properties ​

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
backingreadonlyLocalForageundefined-PersistentCache.backingpackages/minerender/src/cache/PersistentCache.ts:19
VERSIONreadonly22Bump to invalidate every persisted entry.PersistentCache.VERSIONpackages/minerender/src/cache/PersistentCache.ts:13

Methods ​

clear() ​

ts
clear(): Promise<void>;

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:24

Returns ​

Promise<void>

Overrides ​

PersistentCache.clear


delete() ​

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

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:20

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
keystring

Returns ​

Promise<void>

Overrides ​

PersistentCache.delete


forEach() ​

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

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:36

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
callback(v, k) => void

Returns ​

Promise<void>

Overrides ​

PersistentCache.forEach


get() ​

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

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:12

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
keystring

Returns ​

Promise<T>

Overrides ​

PersistentCache.get


getOrLoad() ​

ts
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 ​

ParameterType
keystring
loader(key) => Promise<T>

Returns ​

Promise<T>

Inherited from ​

PersistentCache.getOrLoad


keys() ​

ts
keys(): Promise<string[]>;

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:32

Returns ​

Promise<string[]>

Overrides ​

PersistentCache.keys


length() ​

ts
length(): Promise<number>;

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:28

Returns ​

Promise<number>

Overrides ​

PersistentCache.length


put() ​

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

Defined in: packages/minerender/src/env/browser/BrowserCache.ts:16

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
keystring
valueT

Returns ​

Promise<T>

Overrides ​

PersistentCache.put


open() ​

ts
static open(name): PersistentCache;

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

Parameters ​

ParameterType
namestring

Returns ​

PersistentCache

Inherited from ​

PersistentCache.open