Skip to content
XMachines

Function: buildPlayRouteEvent()

API / @xmachines/play-router / buildPlayRouteEvent

function buildPlayRouteEvent(options): {
  event: PlayRouteEvent;
  pathname: string;
} | null;

Defined in: router-sync.ts:140

Build a normalized play.route event from raw router/browser input.

Both connectRouter() (from @xmachines/play-dom-router) and RouterBridgeBase use this helper so low-level and framework adapters share the same pathname sanitization, route matching, and query extraction behavior.

Parameters

ParameterType
optionsBuildPlayRouteEventOptions

Returns

| { event: PlayRouteEvent; pathname: string; } | null