Skip to content

ActionDef

Defined in: core/define.ts:161

S

I

O

PN extends string

R = Json

optional input?: StandardSchemaV1<unknown, I>

Defined in: core/define.ts:163

Validates the action's input (any Standard Schema library). Omit for no input.


optional internal?: boolean

Defined in: core/define.ts:165

Only timers and the engine may run it; clients get ACTION_NOT_ALLOWED.


optional once?: boolean

Defined in: core/define.ts:167

In a rounds phase: counts as the seat's one submission for the round.


optional preStart?: boolean

Defined in: core/define.ts:169

May run before the table has started (for example ready).

run(args): void | Json | Promise<void | Json>

Defined in: core/define.ts:171

Returns nothing, or a JSON value sent back as the action's result.

ActionArgs<S, I, O, PN, R>

void | Json | Promise<void | Json>