Skip to content

Interface: MachineEdgeData

API / @xmachines/play-router / xstate / MachineEdgeData

Defined in: packages/play-router/src/xstate/machine-types.ts:27

The data on each edge of the graph that represents the machine. It holds the event of the transition and the information of its guard.

Properties

PropertyTypeDescriptionDefined in
eventTypestringThe event type that starts this transitionpackages/play-router/src/xstate/machine-types.ts:29
guardType?stringThe guard as a string, when a guard is present XState 5 holds the guard of a transition as a value that String() describes, and machineToGraph writes that string here. The field carried a “removed in the next major” notice before, and it keeps no such notice now. XState 6 populates it never, so it leaves with the migration to XState 6 and not before: a removal while XState 5 fills it deletes a field that works, and it gives a consumer nothing in its place.packages/play-router/src/xstate/machine-types.ts:41