ShoehiveServer
Defined in: server/server.ts:178
Properties
Section titled “Properties”devtools?
Section titled “devtools?”
readonlyoptionaldevtools?:DevtoolsHandle
Defined in: server/server.ts:193
The devtools inspector, present only when devtools is enabled (ADR 0011).
readonlyready:Promise<void>
Defined in: server/server.ts:180
Resolves once stored tables are recovered (connections wait for it automatically).
tables
Section titled “tables”
readonlytables:object
Defined in: server/server.ts:194
close()
Section titled “close()”close(
id):Promise<void>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”create(
game,options?):Promise<TableInfo>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”string
options?
Section titled “options?”unknown
Returns
Section titled “Returns”Promise<TableInfo>
get(
id):TableInfo|undefined
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TableInfo | undefined
list()
Section titled “list()”list():
TableInfo[]
Returns
Section titled “Returns”reload()
Section titled “reload()”reload(
id):Promise<void>
Reloads a table from the store, for example after it faulted.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
runtime()
Section titled “runtime()”runtime(
id):TableRuntime|undefined
The table's runtime: server-side only, never exposed to clients.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TableRuntime | undefined
start()
Section titled “start()”start(
id):Promise<void>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Methods
Section titled “Methods”attach()
Section titled “attach()”attach(
server):Promise<void>
Defined in: server/server.ts:189
Adds the WebSocket endpoint to an existing HTTP server. With devtools enabled it also
routes devtools paths ahead of the server's current request listeners (restored on
close()); every other request reaches them unchanged. Upgrades to other paths follow
unknownUpgrades.
Parameters
Section titled “Parameters”server
Section titled “server”Server
Returns
Section titled “Returns”Promise<void>
close()
Section titled “close()”close(
options?):Promise<void>
Defined in: server/server.ts:214
Stops the server. Graceful by default: drains table queues, writes a snapshot of
every table, then closes connections with code 1001. graceful: false drops
everything immediately, like a crash (useful to test recovery).
Parameters
Section titled “Parameters”options?
Section titled “options?”graceful?
Section titled “graceful?”boolean
Returns
Section titled “Returns”Promise<void>
connect()
Section titled “connect()”connect(
request?):MemorySocket
Defined in: server/server.ts:191
Opens an in-memory connection (tests, same-process clients).
Parameters
Section titled “Parameters”request?
Section titled “request?”Returns
Section titled “Returns”listen()
Section titled “listen()”listen(
options?):Promise<{port:number;url:string; }>
Defined in: server/server.ts:182
Starts an HTTP server with the WebSocket endpoint. Upgrades to other paths get HTTP 404.
Parameters
Section titled “Parameters”options?
Section titled “options?”string
number
Returns
Section titled “Returns”Promise<{ port: number; url: string; }>
on<
E>(event,listener): () =>void
Defined in: server/server.ts:205
Type Parameters
Section titled “Type Parameters”E extends keyof ServerEvents
Parameters
Section titled “Parameters”E
listener
Section titled “listener”(payload) => void
Returns
Section titled “Returns”() => void
