1681-engine / index / WebStorageBackend

Class: WebStorageBackend

Defined in: src/save/WebStorageBackend.ts:7

Slots in a Web Storage area, localStorage by default. Small and synchronous, so keep saves to a few hundred KB: browsers allow about 5 MB a site, and a write over that throws (reported to the caller of save).

Implements

• SaveBackend

Constructors

Constructor

new WebStorageBackend(storage?): WebStorageBackend;

Defined in: src/save/WebStorageBackend.ts:8

Parameters

Parameter	Type	Default value
storage	Storage	globalThis.localStorage

Returns

WebStorageBackend

Methods

keys()

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

Defined in: src/save/WebStorageBackend.ts:24

Every stored key starting with prefix.

Parameters

Parameter	Type
prefix	string

Returns

Promise<string[]>

Implementation of

SaveBackend.keys

---

read()

read(key): Promise<string | null>;

Defined in: src/save/WebStorageBackend.ts:12

The text stored under key, or null when there is none.

Parameters

Parameter	Type
key	string

Returns

Promise<string | null>

Implementation of

SaveBackend.read

---

remove()

remove(key): Promise<void>;

Defined in: src/save/WebStorageBackend.ts:20

Parameters

Parameter	Type
key	string

Returns

Promise<void>

Implementation of

SaveBackend.remove

---

write()

write(key, value): Promise<void>;

Defined in: src/save/WebStorageBackend.ts:16

Parameters

Parameter	Type
key	string
value	string

Returns

Promise<void>

Implementation of

SaveBackend.write