Skip to content

Interface: RouteTree

Documentation / @xmachines/play-router / RouteTree

Defined in: types.ts:94

Complete route tree with lookup maps

Provides bidirectional mapping between state IDs and URL paths:

  • byStateId: Maps state IDs to route nodes (for play.route event targeting)
  • byPath: Maps URL paths to route nodes (for browser navigation)

Properties

PropertyTypeDescriptionDefined in
byPathMap<string, RouteNode>Map full path -> route node Used to look up state ID from URL path for play.route event targetingtypes.ts:106
byStateIdMap<string, RouteNode>Map state ID -> route node Used to look up URL path from state ID for browser URL synctypes.ts:101
rootRouteNodeRoot route nodetypes.ts:96