Class: BrowserCache
Defined in: packages/minerender/src/env/browser/BrowserCache.ts:10
PersistentCache backed by localforage (IndexedDB / WebSQL / localStorage). Uses an in-memory store when browser storage cannot be opened.
Extends
PersistentCache<LocalForage>
Constructors
Constructor
new BrowserCache(backing): BrowserCache;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:15
Parameters
| Parameter | Type |
|---|---|
backing | LocalForage |
Returns
BrowserCache
Overrides
PersistentCache<LocalForage>.constructorProperties
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|---|
backing | readonly | LocalForage | undefined | - | PersistentCache.backing | packages/minerender/src/cache/PersistentCache.ts:20 |
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/browser/BrowserCache.ts:50
Returns
Promise<void>
Overrides
delete()
delete<T>(key): Promise<void>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:46
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<void>
Overrides
forEach()
forEach<T>(callback): Promise<void>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:62
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
callback | (v, k) => void |
Returns
Promise<void>
Overrides
get()
get<T>(key): Promise<T>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:35
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<T>
Overrides
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>
Inherited from
keys()
keys(): Promise<string[]>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:58
Returns
Promise<string[]>
Overrides
length()
length(): Promise<number>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:54
Returns
Promise<number>
Overrides
put()
put<T>(key, value): Promise<T>;Defined in: packages/minerender/src/env/browser/BrowserCache.ts:39
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
key | string |
value | T |
Returns
Promise<T>
Overrides
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 |