Skip to content

Interface: RouteInfo

API / @xmachines/play-router / RouteInfo

Defined in: types.ts:60

The route information of a state node

Properties

PropertyTypeDescriptionDefined in
isAbsolutebooleanIt tells you if the route path is absolute, which means that it starts with /types.ts:70
metadataRouteMetadataThe original route metadatatypes.ts:77
pattern?stringThe route pattern with its parameters, for example /profile/:userId, when routePath holds a parametertypes.ts:68
routablebooleanIt tells you if this state has a route, which means that it has a meta.route field. true = it has a meta.route field, and it can receive a play.route eventtypes.ts:75
routePathstringThe route path of meta.routetypes.ts:66
stateIdstringThe identifier of the state: node.id, or path.join(’.’)types.ts:62
statePathstring[]The segments of the state path, from the roottypes.ts:64