TableRuntime
Defined in: core/runtime.ts:345
One running table. The server creates one per table; shoehive/testing drives it
directly. All mutating methods are queued and run one at a time.
Properties
Section titled “Properties”
readonlydev:boolean
Defined in: core/runtime.ts:351
readonlygame:AnyGame
Defined in: core/runtime.ts:346
Accessors
Section titled “Accessors”engine
Section titled “engine”Get Signature
Section titled “Get Signature”get engine():
Readonly<EngineState>
Defined in: core/runtime.ts:831
The committed engine bookkeeping. Treat as read-only.
Returns
Section titled “Returns”Readonly<EngineState>
faulted
Section titled “faulted”Get Signature
Section titled “Get Signature”get faulted():
boolean
Defined in: core/runtime.ts:384
True after a persist failure. The table must be reloaded from its store.
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get id():
string
Defined in: core/runtime.ts:817
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get log(): readonly
LogEntry[]
Defined in: core/runtime.ts:835
The log of committed entries, oldest first.
Returns
Section titled “Returns”readonly LogEntry[]
Get Signature
Section titled “Get Signature”get rev():
number
Defined in: core/runtime.ts:820
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get state():
unknown
Defined in: core/runtime.ts:827
The committed raw state. Server-side only: never send it to clients.
Returns
Section titled “Returns”unknown
status
Section titled “status”Get Signature
Section titled “Get Signature”get status():
TableStatus
Defined in: core/runtime.ts:823
Returns
Section titled “Returns”Methods
Section titled “Methods”act(
args):Promise<{result:Json|undefined;rev:number; }>
Defined in: core/runtime.ts:927
Runs a client action. Rejects with a ShoehiveError.
Parameters
Section titled “Parameters”input?
Section titled “input?”unknown
string
player
Section titled “player”string
number
number
Returns
Section titled “Returns”Promise<{ result: Json | undefined; rev: number; }>
diagnostics()
Section titled “diagnostics()”diagnostics(): readonly
Diagnostic[]
Defined in: core/runtime.ts:839
Recently rejected actions (not part of the log).
Returns
Section titled “Returns”readonly Diagnostic[]
disconnect()
Section titled “disconnect()”disconnect(
args):Promise<void>
Defined in: core/runtime.ts:1030
Marks every seat of player as reserved and disconnected.
Parameters
Section titled “Parameters”player
Section titled “player”string
Returns
Section titled “Returns”Promise<void>
dispose()
Section titled “dispose()”dispose():
void
Defined in: core/runtime.ts:807
Stops timers and refuses further entries.
Returns
Section titled “Returns”void
idle()
Section titled “idle()”idle():
Promise<void>
Defined in: core/runtime.ts:918
Resolves once the queue is empty, including follow-up entries such as auto-start.
Returns
Section titled “Returns”Promise<void>
meta()
Section titled “meta()”meta():
TableMeta
Defined in: core/runtime.ts:847
Returns
Section titled “Returns”onCommit()
Section titled “onCommit()”onCommit(
listener): () =>void
Defined in: core/runtime.ts:912
Subscribes to commits. Returns an unsubscribe function.
Parameters
Section titled “Parameters”listener
Section titled “listener”(commit) => void
Returns
Section titled “Returns”() => void
reconnect()
Section titled “reconnect()”reconnect(
args):Promise<void>
Defined in: core/runtime.ts:1035
Marks every seat of player as occupied and connected again.
Parameters
Section titled “Parameters”player
Section titled “player”string
Returns
Section titled “Returns”Promise<void>
releaseOpenReservations()
Section titled “releaseOpenReservations()”releaseOpenReservations():
void
Defined in: core/runtime.ts:586
Releases every reservation still open (call when a table closes, ADR 0007 rule 4).
Returns
Section titled “Returns”void
rename()
Section titled “rename()”rename(
args):Promise<void>
Defined in: core/runtime.ts:1040
Updates the display name on every seat player holds. No game hook runs.
Parameters
Section titled “Parameters”string
player
Section titled “player”string
Returns
Section titled “Returns”Promise<void>
seats()
Section titled “seats()”seats():
SeatInfo[]
Defined in: core/runtime.ts:843
Returns
Section titled “Returns”SeatInfo[]
seatsHeldBy()
Section titled “seatsHeldBy()”seatsHeldBy(
playerId):number[]
Defined in: core/runtime.ts:394
The seats playerId holds at this table, ascending.
Parameters
Section titled “Parameters”playerId
Section titled “playerId”string
Returns
Section titled “Returns”number[]
setPersist()
Section titled “setPersist()”setPersist(
persist):void
Defined in: core/runtime.ts:389
Sets the persistence hook, for example after recovering a table by replay.
Parameters
Section titled “Parameters”persist
Section titled “persist”((entry) => void | Promise<void>) | undefined
Returns
Section titled “Returns”void
sit(
args):Promise<{rev:number;seat:number; }>
Defined in: core/runtime.ts:989
Seats a player. Without seat, takes the lowest free seat.
Parameters
Section titled “Parameters”player
Section titled “player”{ id: string; name: string; }
player.id
Section titled “player.id”string
player.name
Section titled “player.name”string
number
Returns
Section titled “Returns”Promise<{ rev: number; seat: number; }>
snapshot()
Section titled “snapshot()”snapshot():
Snapshot
Defined in: core/runtime.ts:576
A copy of the table's current state and engine bookkeeping.
Returns
Section titled “Returns”stand()
Section titled “stand()”stand(
args):Promise<{rev:number; }>
Defined in: core/runtime.ts:1018
Frees a seat (the player stood up, or their reconnect grace expired).
Parameters
Section titled “Parameters”reason?
Section titled “reason?”"stand" | "grace-expired"
number
Returns
Section titled “Returns”Promise<{ rev: number; }>
start()
Section titled “start()”start():
Promise<void>
Defined in: core/runtime.ts:1054
Starts a table that is waiting (operator API, or autoStart: false).
Returns
Section titled “Returns”Promise<void>
view()
Section titled “view()”view(
viewer):Json
Defined in: core/runtime.ts:882
The game's view() for viewer at the current revision (cached per rev).
Parameters
Section titled “Parameters”viewer
Section titled “viewer”Returns
Section titled “Returns”viewerFor()
Section titled “viewerFor()”viewerFor(
playerId):Viewer
Defined in: core/runtime.ts:873
The viewer for a player: their seats if they hold any, otherwise a spectator.
Parameters
Section titled “Parameters”playerId
Section titled “playerId”string | null
Returns
Section titled “Returns”create()
Section titled “create()”
staticcreate(game,args?):Promise<TableRuntime>
Defined in: core/runtime.ts:402
Creates a new table: validates options, seeds the RNG and runs setup.
Parameters
Section titled “Parameters”RuntimeOptions & object = {}
Returns
Section titled “Returns”Promise<TableRuntime>
replay()
Section titled “replay()”
staticreplay(game,log,args?):Promise<TableRuntime>
Defined in: core/runtime.ts:493
Rebuilds a table from its log, optionally starting from a snapshot. With
live: true the result arms its timers and accepts new entries (restart
recovery); otherwise it is a read-only copy (tests, devtools).
Parameters
Section titled “Parameters”readonly LogEntry[]
RuntimeOptions & object = {}
Returns
Section titled “Returns”Promise<TableRuntime>
