Skip to content

Interface: RouteInfo

API / @xmachines/play-router / RouteInfo

Defined in: play-router/src/types.ts:61

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 /play-router/src/types.ts:71
metadataRouteMetadataThe original route metadataplay-router/src/types.ts:78
pattern?stringThe route pattern with its parameters, for example /profile/:userId, when routePath holds a parameterplay-router/src/types.ts:69
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 eventplay-router/src/types.ts:76
routePathstringThe route path of meta.routeplay-router/src/types.ts:67
stateIdstringThe identifier of the state: node.id, or path.join(’.’)play-router/src/types.ts:63
statePathstring[]The segments of the state path, from the rootplay-router/src/types.ts:65