TableHandle
Defined in: client/client.ts:149
A joined table. Its document stays in sync with the server.
Type Parameters
Section titled “Type Parameters”Properties
Section titled “Properties”closedReason
Section titled “closedReason”closedReason:
string|null=null
Defined in: client/client.ts:161
Set when the server closed the table.
doc:
TableDocument|null=null
Defined in: client/client.ts:151
The latest document, or null until the first snapshot arrives.
readonlyid:string
Defined in: client/client.ts:169
rev:
number=-1
Defined in: client/client.ts:152
role:
"player"|"spectator"
Defined in: client/client.ts:163
The role this handle joined with, restored on reconnect.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get meta():
TypedTableMeta<G>
Defined in: client/client.ts:189
Status, phase, turn, round, options and (once ended) the typed result.
Returns
Section titled “Returns”mySeat
Section titled “mySeat”Get Signature
Section titled “Get Signature”get mySeat():
number|null
Defined in: client/client.ts:199
This player's first seat, or null.
Returns
Section titled “Returns”number | null
Get Signature
Section titled “Get Signature”get seats():
SeatInfo[]
Defined in: client/client.ts:192
Returns
Section titled “Returns”SeatInfo[]
Get Signature
Section titled “Get Signature”get view():
GameView<G>
Defined in: client/client.ts:185
What this viewer may see: the game's view() output.
Returns
Section titled “Returns”GameView<G>
Get Signature
Section titled “Get Signature”get you():
object
Defined in: client/client.ts:195
Returns
Section titled “Returns”object
player
Section titled “player”player:
string
role:
"player"|"spectator"
seats:
number[]
Methods
Section titled “Methods”act<
K>(name, ...input):Promise<ActResult>
Defined in: client/client.ts:221
Runs an action. Resolves after the server applied it (your document already shows it).
Type Parameters
Section titled “Type Parameters”K extends string
Parameters
Section titled “Parameters”K
...ActArgs<G, K>
Returns
Section titled “Returns”Promise<ActResult>
leave()
Section titled “leave()”leave():
Promise<void>
Defined in: client/client.ts:250
Leaves the table. Seated players stand up.
Returns
Section titled “Returns”Promise<void>
on(
name,listener): () =>void
Defined in: client/client.ts:210
Listens for ephemeral events sent with ctx.emit().
Parameters
Section titled “Parameters”string
listener
Section titled “listener”Listener<{ payload: Json; rev: number; }>
Returns
Section titled “Returns”() => void
ready()
Section titled “ready()”ready():
Promise<void>
Defined in: client/client.ts:180
Resolves once the first snapshot has arrived.
Returns
Section titled “Returns”Promise<void>
sit(
seat?):Promise<number>
Defined in: client/client.ts:231
Takes a seat (the lowest free one by default). Resolves with the seat number.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<number>
stand()
Section titled “stand()”stand(
seat?):Promise<void>
Defined in: client/client.ts:242
Gives up a seat (all of yours by default).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<void>
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Defined in: client/client.ts:204
Calls listener with the new document after every change.
Parameters
Section titled “Parameters”listener
Section titled “listener”Listener<TableDocument>
Returns
Section titled “Returns”() => void
sync()
Section titled “sync()”sync():
Promise<void>
Defined in: client/client.ts:256
Asks for a fresh snapshot.
Returns
Section titled “Returns”Promise<void>
