Skip to content

Type Alias: PlayRouterBridgeConstructor<TRouter>

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

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

Defined in: packages/play-solid-router/src/create-play-router-provider.tsx:25

Constructor shape a bridge class must satisfy to be used with createPlayRouterProvider: (router, actor, routeMap) → RouterBridge.

Bridges with a different constructor shape (e.g. SolidRouterBridge, which takes the hook results as separate arguments) are adapted with a thin subclass that repackages the router prop.

Type Parameters

Type Parameter
TRouter

Parameters

ParameterType
routerTRouter
actorPlayActor
routeMapRouteMap

Returns

RouterBridge