Store
Defined in: store/types.ts:28
Properties
Section titled “Properties”sessions
Section titled “sessions”sessions:
object
Defined in: store/types.ts:50
delete()
Section titled “delete()”delete(
playerId):Promise<void>
Parameters
Section titled “Parameters”playerId
Section titled “playerId”string
Returns
Section titled “Returns”Promise<void>
get(
playerId):Promise<SessionRecord|null>
Parameters
Section titled “Parameters”playerId
Section titled “playerId”string
Returns
Section titled “Returns”Promise<SessionRecord | null>
put(
record):Promise<void>
Parameters
Section titled “Parameters”record
Section titled “record”Returns
Section titled “Returns”Promise<void>
Methods
Section titled “Methods”appendLog()
Section titled “appendLog()”appendLog(
tableId,entries):Promise<void>
Defined in: store/types.ts:36
Appends entries in seq order, all or nothing. A table's log starts at seq 0 and each
entry must follow the last stored one; otherwise rejects with StoreConflictError.
A batch whose entries are all already stored with identical data succeeds without
writing (so a driver may safely retry after a lost reply); any other overlap is a
conflict. An empty batch is a no-op.
Parameters
Section titled “Parameters”tableId
Section titled “tableId”string
entries
Section titled “entries”Returns
Section titled “Returns”Promise<void>
close()
Section titled “close()”close():
Promise<void>
Defined in: store/types.ts:55
Returns
Section titled “Returns”Promise<void>
closeTable()
Section titled “closeTable()”closeTable(
tableId,reason):Promise<void>
Defined in: store/types.ts:49
Marks a table closed: it is kept but no longer recovered. A snapshot saved after this (the engine snapshots a table as it ends) does not reopen it.
Parameters
Section titled “Parameters”tableId
Section titled “tableId”string
reason
Section titled “reason”string
Returns
Section titled “Returns”Promise<void>
listOpenTables()
Section titled “listOpenTables()”listOpenTables():
Promise<string[]>
Defined in: store/types.ts:44
Tables to recover on startup.
Returns
Section titled “Returns”Promise<string[]>
loadTable()
Section titled “loadTable()”loadTable(
tableId):Promise<{snapshot:StoredSnapshot;tail:StoredEntry[]; } |null>
Defined in: store/types.ts:40
The latest snapshot and every entry after it, or null for an unknown table.
Parameters
Section titled “Parameters”tableId
Section titled “tableId”string
Returns
Section titled “Returns”Promise<{ snapshot: StoredSnapshot; tail: StoredEntry[]; } | null>
readLog()
Section titled “readLog()”readLog(
tableId,fromSeq,toSeq?):Promise<StoredEntry[]>
Defined in: store/types.ts:42
Entries with fromSeq <= seq <= toSeq (devtools replay).
Parameters
Section titled “Parameters”tableId
Section titled “tableId”string
fromSeq
Section titled “fromSeq”number
toSeq?
Section titled “toSeq?”number
Returns
Section titled “Returns”Promise<StoredEntry[]>
saveSnapshot()
Section titled “saveSnapshot()”saveSnapshot(
tableId,snapshot):Promise<void>
Defined in: store/types.ts:38
Replaces the table's snapshot.
Parameters
Section titled “Parameters”tableId
Section titled “tableId”string
snapshot
Section titled “snapshot”Returns
Section titled “Returns”Promise<void>
