Skip to content

1681-engine / index / SaveBackend

Interface: SaveBackend ​

Defined in: src/save/SaveBackend.ts:6

Where save slots are kept. Asynchronous so a game can plug in IndexedDB, a file through Electron, or a native key–value store (Capacitor Preferences, a secure store) behind the same SaveStore; the synchronous ones (WebStorageBackend, MemoryBackend) simply answer at once.

Methods ​

keys() ​

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

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

Every stored key starting with prefix.

Parameters ​

ParameterType
prefixstring

Returns ​

Promise<string[]>


read() ​

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

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

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

Parameters ​

ParameterType
keystring

Returns ​

Promise<string | null>


remove() ​

ts
remove(key): Promise<void>;

Defined in: src/save/SaveBackend.ts:10

Parameters ​

ParameterType
keystring

Returns ​

Promise<void>


write() ​

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

Defined in: src/save/SaveBackend.ts:9

Parameters ​

ParameterType
keystring
valuestring

Returns ​

Promise<void>

Released under the MIT License.