Skip to content

Interface: RouteMapping

Documentation / @xmachines/play-tanstack-react-router / RouteMapping

Defined in: play-tanstack-react-router/src/route-map.ts:22

Mapping between state machine state ID and router path.

Structurally compatible with BaseRouteMapping from @xmachines/play-router. Fields are readonly — entries are immutable once passed to RouteMap.

Properties

PropertyModifierTypeDescriptionDefined in
pathreadonlystringRouter path with optional parameters (e.g., "/settings/:section?")play-tanstack-react-router/src/route-map.ts:26
stateIdreadonlystringState ID from state machine (e.g., "home", "settings.profile")play-tanstack-react-router/src/route-map.ts:24