ClassStorage & Replay@public

IndexedDBBackend

Optional IndexedDB-backed storage adapter.

Reads from a cache populated while opening. Writes and erases must use the async FlxSave methods so their results represent transaction completion.

Usage:

const db = await IndexedDBBackend.open('my-game-saves');
const save = new FlxSave();
save.bind('slot1', { backend: db });
await save.flushAsync();

export declare class IndexedDBBackend implements FlxAsyncStorageBackend

Methods

close()

close(key: string): void

Parameters:

Parameter	Type	Description
key	string	-

Returns: void

closeDatabase()

closeDatabase(): void

Close the underlying IDBDatabase connection.

Returns: void

erase()

erase(key: string): boolean

Parameters:

Parameter	Type	Description
key	string	-

Returns: boolean

eraseAsync()

eraseAsync(key: string): Promise<boolean>

Delete a record and resolve only after its transaction commits.

Parameters:

Parameter	Type	Description
key	string	-

Returns: Promise<boolean>

static open()

static open(dbName: string): Promise<IndexedDBBackend>

Open (or create) the named database and return a ready backend.

Parameters:

Parameter	Type	Description
dbName	string	The IndexedDB database name.

Returns: Promise<IndexedDBBackend>

read()

read(key: string): Record<string, unknown> | null

Parameters:

Parameter	Type	Description
key	string	-

Returns: Record<string, unknown> | null

write()

write(key: string, data: Record<string, unknown>): FlxSaveResult

Parameters:

Parameter	Type	Description
key	string	-
data	Record<string, unknown>	-

Returns: FlxSaveResult

writeAsync()

writeAsync(key: string, data: Record<string, unknown>): Promise<FlxSaveResult>

Persist a record and resolve only after its transaction commits.

Parameters:

Parameter	Type	Description
key	string	-
data	Record<string, unknown>	-

Returns: Promise<FlxSaveResult>