@ue-too/being / EventGuards

Type Alias: EventGuards<EventPayloadMapping, States, Context, T>

EventGuards<EventPayloadMapping, States, Context, T> = { [K in keyof EventPayloadMapping]: GuardMapping<Context, T, States>[] }

Type Parameters

EventPayloadMapping

States extends string

Context extends BaseContext

T extends Guard<Context>

This is a mapping of an event to a guard evaluation.

Generic parameters:

EventPayloadMapping: A mapping of events to their payloads.
States: All of the possible states that the state machine can be in. e.g. a string literal union like "IDLE" | "SELECTING" | "PAN" | "ZOOM"
Context: The context of the state machine. (which can be used by each state to do calculations that would persist across states)
T: The guard type.

You probably don't need to use this type directly. This is a mapping of an event to a guard evaluation.