Interface: RouteNode
API / @xmachines/play-router / RouteNode
Defined in: types.ts:79
Node in the route tree representing a single route
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
children | RouteNode[] | Child routes | types.ts:103 |
fullPath | string | The fully resolved absolute path from the root (e.g. "/dashboard/overview"). Always use fullPath for browser URL matching and route map construction. createRouteMapFromTree and createRouteMap both use this field. | types.ts:92 |
id | string | Unique identifier (state ID) | types.ts:81 |
metadata | RouteMetadata | Original meta.route metadata | types.ts:107 |
parent | RouteNode | null | Parent route (null for root) | types.ts:105 |
path | string | The raw route path segment as declared in meta.route — may be relative (e.g. "overview") or absolute (e.g. "/dashboard"). Do not use this for URL matching; use fullPath instead. | types.ts:86 |
pattern? | string | Route pattern with parameters (e.g., /profile/:userId) if path contains params | types.ts:94 |
routable | boolean | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | types.ts:101 |
stateId | string | XState state ID this route maps to | types.ts:96 |