ActionDef
Defined in: core/define.ts:161
Type Parameters
Section titled “Type Parameters”S
I
O
PN extends string
R = Json
Properties
Section titled “Properties”input?
Section titled “input?”
optionalinput?:StandardSchemaV1<unknown,I>
Defined in: core/define.ts:163
Validates the action's input (any Standard Schema library). Omit for no input.
internal?
Section titled “internal?”
optionalinternal?:boolean
Defined in: core/define.ts:165
Only timers and the engine may run it; clients get ACTION_NOT_ALLOWED.
optionalonce?:boolean
Defined in: core/define.ts:167
In a rounds phase: counts as the seat's one submission for the round.
preStart?
Section titled “preStart?”
optionalpreStart?:boolean
Defined in: core/define.ts:169
May run before the table has started (for example ready).
Methods
Section titled “Methods”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.
Parameters
Section titled “Parameters”ActionArgs<S, I, O, PN, R>
Returns
Section titled “Returns”void | Json | Promise<void | Json>
