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
| Property | Type | Description | Defined in |
|---|---|---|---|
isAbsolute | boolean | It tells you if the route path is absolute, which means that it starts with / | packages/play-router/src/types.ts:166 |
metadata | RouteMetadata | The original route metadata | packages/play-router/src/types.ts:173 |
pattern? | string | The route pattern with its parameters, for example /profile/:userId, when routePath holds a parameter | packages/play-router/src/types.ts:164 |
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 | packages/play-router/src/types.ts:171 |
routePath | string | The route path of meta.route | packages/play-router/src/types.ts:162 |
stateId | string | The identifier of the state: node.id, or path.join(’.’) | packages/play-router/src/types.ts:158 |
statePath | string[] | The segments of the state path, from the root | packages/play-router/src/types.ts:160 |