Type Alias: Guard<TContext, TEvent>

Documentation / @xmachines/play-xstate / Guard

type Guard<TContext, TEvent> = (args) => boolean;

Defined in: packages/play-xstate/src/guards/types.ts:13

Standard XState guard function signature

Per CONTEXT.md: Guards receive { context, event } per XState standard

Type Parameters

Type Parameter	Default type
TContext	Record<string, unknown>
TEvent	PlayEvent

Parameters

Parameter	Type	Description
args	{ context: TContext; event: TEvent; }	Guard arguments with context and event
args.context	TContext	Current machine context
args.event	TEvent	Event that triggered the guard evaluation

Returns

boolean

boolean indicating if guard passes