Function: openProviderBridge()
API / @xmachines/play-router / index / openProviderBridge
function openProviderBridge<TRouter, TActor>(BridgeCtor, __namedParameters): object;Defined in: packages/play-router/src/provider-lifecycle.ts:201
Builds a bridge, connects it, and hands back the way to close it.
The order is the contract: the constructor applies the mount, connect() runs the
first synchronization against it, and close() disconnects exactly the bridge that
this call opened. A provider that closed “the current bridge” instead would
disconnect a later one when two mounts overlap.
Type Parameters
| Type Parameter |
|---|
TRouter |
TActor extends RoutableActor |
Parameters
| Parameter | Type |
|---|---|
BridgeCtor | PlayRouterBridgeConstructor<TRouter, TActor> |
__namedParameters | OpenProviderBridgeArgs<TRouter, TActor> |
Returns
object
The bridge, and a close that disconnects it one time.
| Name | Type | Defined in |
|---|---|---|
bridge | RouterBridge | packages/play-router/src/provider-lifecycle.ts:204 |
close() | () => void | packages/play-router/src/provider-lifecycle.ts:204 |