Interface: OpenProviderBridgeArgs<TRouter, TActor>
API / @xmachines/play-router / OpenProviderBridgeArgs
Defined in: play-router/src/provider-lifecycle.ts:163
What openProviderBridge needs to build and connect a bridge.
Extends
Type Parameters
| Type Parameter |
|---|
TRouter |
TActor extends PlayActor |
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
actor | public | TActor | - | - | play-router/src/provider-lifecycle.ts:165 |
basePath? | readonly | string | The URL prefix that the routes of the machine hang off, for example "/admin" or "/:machineId/play". A :param segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every :param must have a value in BasePathOptions.basePathParams, because the bridge writes a real URL. An optional segment (:param?) and a wildcard (*) are therefore refused: neither of them resolves to one concrete prefix. An absent value, "", and "/" all mean “no prefix”, which is the behaviour of every release before this option existed. | BasePathOptions.basePath | play-router/src/base-path.ts:58 |
basePathParams? | readonly | Record<string, string | number> | The values of the :param segments of BasePathOptions.basePath. These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO play.route event: the machine is authoritative over its own params, and event.params holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from bridge.basePathParams, where they cannot go stale. A machine that needs the identity of its host takes it through the input of the actor, where that identity decides WHICH machine runs. | BasePathOptions.basePathParams | play-router/src/base-path.ts:72 |
routeMap | public | RouteMap | - | - | play-router/src/provider-lifecycle.ts:166 |
router | public | TRouter | - | - | play-router/src/provider-lifecycle.ts:164 |