Skip to content

Interface: RouteInfo

API / @xmachines/play-router / index / RouteInfo

Defined in: packages/play-router/src/types.ts:156

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 /packages/play-router/src/types.ts:166
metadataRouteMetadataThe original route metadatapackages/play-router/src/types.ts:173
pattern?stringThe route pattern with its parameters, for example /profile/:userId, when routePath holds a parameterpackages/play-router/src/types.ts:164
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 eventpackages/play-router/src/types.ts:171
routePathstringThe route path of meta.routepackages/play-router/src/types.ts:162
stateIdstringThe identifier of the state: node.id, or path.join(’.’)packages/play-router/src/types.ts:158
statePathstring[]The segments of the state path, from the rootpackages/play-router/src/types.ts:160