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:24

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

A bridge with another constructor shape, for example SolidRouterBridge, which takes each hook result as a separate argument, receives a thin subclass. That subclass packs the router prop again.

Type Parameters

Type Parameter
TRouter

Parameters

ParameterType
routerTRouter
actorPlayActor
routeMapRouteMap

Returns

RouterBridge