Skip to content
XMachines

Function: buildPlayRouteEvent()

API / @xmachines/play-router / buildPlayRouteEvent

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

Defined in: router-sync.ts:175

Builds a normalized play.route event from the raw input of a router or of a browser.

connectRouter() of @xmachines/play-dom-router and RouterBridgeBase both use this helper. Therefore a low-level adapter and a framework adapter clean each pathname, match each route, and read each query in the same way.

Parameters

ParameterType
optionsBuildPlayRouteEventOptions

Returns

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