Interface: RouteInfo
API / @xmachines/play-router / RouteInfo
Defined in: types.ts:60
The route information of a state node
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
isAbsolute | boolean | It tells you if the route path is absolute, which means that it starts with / | types.ts:70 |
metadata | RouteMetadata | The original route metadata | types.ts:77 |
pattern? | string | The route pattern with its parameters, for example /profile/:userId, when routePath holds a parameter | types.ts:68 |
routable | boolean | It 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 event | types.ts:75 |
routePath | string | The route path of meta.route | types.ts:66 |
stateId | string | The identifier of the state: node.id, or path.join(’.’) | types.ts:62 |
statePath | string[] | The segments of the state path, from the root | types.ts:64 |