Skip to content

Interface: RouteInfo

Documentation / @xmachines/play-router / RouteInfo

Defined in: types.ts:40

Extracted route information from a state node

Properties

PropertyTypeDescriptionDefined in
isAbsolutebooleanWhether route path is absolute (starts with /)types.ts:50
metadataRouteMetadataOriginal route metadatatypes.ts:57
pattern?stringRoute pattern with parameters (e.g., /profile/:userId) if routePath contains paramstypes.ts:48
routablebooleanWhether this state is routable (has meta.route) true = has meta.route, can receive play.route eventstypes.ts:55
routePathstringRoute path extracted from meta.routetypes.ts:46
stateIdstringState identifier (node.id or path.join(’.‘))types.ts:42
statePathstring[]State path segments from roottypes.ts:44