Skip to content

Type Alias: PlayRouterBridgeConstructor<TRouter>

API / @xmachines/play-react-router / PlayRouterBridgeConstructor

type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap, options?) => RouterBridge;

Defined in: play-router/src/provider-lifecycle.ts:103

The constructor shape that a bridge class must satisfy for a provider factory: (router, actor, routeMap, options?) → RouterBridge.

The return type is RouterBridge, the published contract of a bridge, so a consumer bridge of its own keeps compiling. Every bridge on RouterBridgeBase also satisfies MountableRouterBridge, and the provider finds that mount API at run time: a bridge without it ignores basePath, exactly as it did before the option existed.

Type Parameters

Type Parameter
TRouter

Parameters

ParameterType
routerTRouter
actorPlayActor
routeMapRouteMap
options?BasePathOptions

Returns

RouterBridge