module@warp-drive/experiments/storage @experimental

Class CacheStorage

Defined in: storage/cache.ts:84

A reactive interface for json stored in the browser Cache API.

This is a good option for larger data sets than can be efficiently stored in localStorage but should not be used as a permanent DB or storage solution.

Implements

• Storage

Constructors

Constructor

new CacheStorage(cacheId): CacheStorage;

Defined in: storage/cache.ts:102

Parameters

cacheId

string

Returns

CacheStorage

Methods

clear()

clear(): void;

Defined in: storage/cache.ts:136

The clear() method of the Storage interface clears all keys stored in a given Storage object.

MDN Reference

Returns

void

Implementation of

Storage.clear

---

getItem()

getItem(key): string | null;

Defined in: storage/cache.ts:141

The getItem() method of the Storage interface, when passed a key name, will return that key's value, or null if the key does not exist, in the given Storage object.

MDN Reference

Parameters

key

string

Returns

string | null

Implementation of

Storage.getItem

---

key()

key(index): string | null;

Defined in: storage/cache.ts:145

The key() method of the Storage interface, when passed a number n, returns the name of the nth key in a given Storage object. The order of keys is user-agent defined, so you should not rely on it.

MDN Reference

Parameters

index

number

Returns

string | null

Implementation of

Storage.key

---

removeItem()

removeItem(key): void;

Defined in: storage/cache.ts:161

The removeItem() method of the Storage interface, when passed a key name, will remove that key from the given Storage object if it exists. The Storage interface of the Web Storage API provides access to a particular domain's session or local storage.

MDN Reference

Parameters

key

string

Returns

void

Implementation of

Storage.removeItem

---

setItem()

setItem(key, value): void;

Defined in: storage/cache.ts:169

The setItem() method of the Storage interface, when passed a key name and value, will add that key to the given Storage object, or update that key's value if it already exists.

MDN Reference

Parameters

key

string

value

string

Returns

void

Implementation of

Storage.setItem

---

expectCache()

static expectCache(cacheId?): CacheStorage;

Defined in: storage/cache.ts:193

Parameters

cacheId?

string = DEFAULT_CACHE_ID

Returns

CacheStorage

---

get()

static get(cacheId?): Promise<CacheStorage>;

Defined in: storage/cache.ts:184

Get the singleton CacheStorage instance.

Parameters

cacheId?

string = DEFAULT_CACHE_ID

Returns

Promise<CacheStorage>

---

getAllCacheIds()

static getAllCacheIds(): string[];

Defined in: storage/cache.ts:205

Returns the IDs of all CacheStorage instances that have been opened in this context via CacheStorage.get.

Returns

string[]

Properties

_bufferedEvents

_bufferedEvents: InternalCacheStorageEvent[] = [];

Defined in: storage/cache.ts:90

---

_data

_data: Map<string, string | null>;

Defined in: storage/cache.ts:88

---

_nextUpdate

_nextUpdate: number | null = null;

Defined in: storage/cache.ts:89

length

Get Signature

get length(): number;

Defined in: storage/cache.ts:108

The length read-only property of the Storage interface returns the number of data items stored in a given Storage object.

MDN Reference

Returns

number

Implementation of

Storage.length