Skip to content

TableHandle

Defined in: client/client.ts:149

A joined table. Its document stays in sync with the server.

G extends AnyGame = AnyGame

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.


readonly id: 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.

get meta(): TypedTableMeta<G>

Defined in: client/client.ts:189

Status, phase, turn, round, options and (once ended) the typed result.

TypedTableMeta<G>


get mySeat(): number | null

Defined in: client/client.ts:199

This player's first seat, or null.

number | null


get seats(): SeatInfo[]

Defined in: client/client.ts:192

SeatInfo[]


get view(): GameView<G>

Defined in: client/client.ts:185

What this viewer may see: the game's view() output.

GameView<G>


get you(): object

Defined in: client/client.ts:195

object

player: string

role: "player" | "spectator"

seats: number[]

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).

K extends string

K

...ActArgs<G, K>

Promise<ActResult>


leave(): Promise<void>

Defined in: client/client.ts:250

Leaves the table. Seated players stand up.

Promise<void>


on(name, listener): () => void

Defined in: client/client.ts:210

Listens for ephemeral events sent with ctx.emit().

string

Listener<{ payload: Json; rev: number; }>

() => void


ready(): Promise<void>

Defined in: client/client.ts:180

Resolves once the first snapshot has arrived.

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.

number

Promise<number>


stand(seat?): Promise<void>

Defined in: client/client.ts:242

Gives up a seat (all of yours by default).

number

Promise<void>


subscribe(listener): () => void

Defined in: client/client.ts:204

Calls listener with the new document after every change.

Listener<TableDocument>

() => void


sync(): Promise<void>

Defined in: client/client.ts:256

Asks for a fresh snapshot.

Promise<void>