Skip to content

Interface: RouteNode

Documentation / @xmachines/play-router / RouteNode

Defined in: types.ts:63

Node in the route tree representing a single route

Properties

PropertyTypeDescriptionDefined in
childrenRouteNode[]Child routestypes.ts:80
fullPathstringFull resolved path from roottypes.ts:69
idstringUnique identifier (state ID)types.ts:65
metadataunknownOriginal meta.route metadatatypes.ts:84
parentRouteNode | nullParent route (null for root)types.ts:82
pathstringRoute path segment (relative or absolute)types.ts:67
pattern?stringRoute pattern with parameters (e.g., /profile/:userId) if path contains paramstypes.ts:71
routablebooleanWhether this state is routable (has meta.route) States with meta.route can receive play.route eventstypes.ts:78
stateIdstringXState state ID this route maps totypes.ts:73