Skip to content

1681-engine / index / SaveStoreOptions

Interface: SaveStoreOptions ​

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

Properties ​

backend? ​

ts
optional backend?: SaveBackend;

Defined in: src/save/SaveStore.ts:13

Where slots are kept (default localStorage, or memory where there is none).


backup? ​

ts
optional backup?: boolean;

Defined in: src/save/SaveStore.ts:17

Keep the slot's previous good save beside it and fall back to it when the slot is corrupt (default true).


migrations? ​

ts
optional migrations?: Readonly<Record<number, (data) => unknown>>;

Defined in: src/save/SaveStore.ts:11

migrations[n] turns data of version n into version n + 1.


now? ​

ts
optional now?: () => number;

Defined in: src/save/SaveStore.ts:19

Wall clock for savedAt (default Date.now).

Returns ​

number


prefix? ​

ts
optional prefix?: string;

Defined in: src/save/SaveStore.ts:15

Prepended to every slot's key, so two games (or a game and its tools) on one origin never share slots.


version ​

ts
version: number;

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

The schema version this build writes; older saves go through migrations on load.

Released under the MIT License.