@xmachines/docs 2.1.1 → 2.2.0

package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md

@@ -2,7 +2,7 @@
 
 # Interface: BrowserWindow
 
-Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L59)
+Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L59)
 
 The minimal window interface of createBrowserHistory
 
@@ -15,17 +15,17 @@ different in each environment.
 
 | Property                                  | Modifier   | Type      | Defined in                                                                                                                                                              |
 | ----------------------------------------- | ---------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`   | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L60) |
-| `history.state`                           | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L61) |
-| `history.back`                            | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L65) |
-| `history.forward`                         | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L66) |
-| `history.go`                              | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L64) |
-| `history.pushState`                       | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L62) |
-| `history.replaceState`                    | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L63) |
-| <a id="property-location"></a> `location` | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L68) |
-| `location.hash`                           | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L71) |
-| `location.pathname`                       | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L69) |
-| `location.search`                         | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L70) |
+| <a id="property-history"></a> `history`   | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L60) |
+| `history.state`                           | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L61) |
+| `history.back`                            | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L65) |
+| `history.forward`                         | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L66) |
+| `history.go`                              | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L64) |
+| `history.pushState`                       | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L62) |
+| `history.replaceState`                    | `public`   | `void`    | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L63) |
+| <a id="property-location"></a> `location` | `public`   | `object`  | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L68) |
+| `location.hash`                           | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L71) |
+| `location.pathname`                       | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L69) |
+| `location.search`                         | `readonly` | `string`  | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L70) |
 
 ## Methods
 
@@ -35,7 +35,7 @@ different in each environment.
 addEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L73)
+Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L73)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.co
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-browser-history.ts#L74)
+Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-browser-history.ts#L74)
 
 #### Parameters
 

package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md

@@ -2,14 +2,20 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [play-dom-router/src/connect-router.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L23)
+Defined in: [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L24)
 
 The options of [connectRouter](../functions/connectRouter.md).
 
+## Extends
+
+- [`BasePathOptions`](BasePathOptions.md)
+
 ## Properties
 
-| Property                                  | Modifier   | Type                                            | Description                                                                   | Defined in                                                                                                                                              |
-| ----------------------------------------- | ---------- | ----------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | `readonly` | [`RoutableActor`](RoutableActor.md)             | The actor to keep in step with the browser URL. It must implement `Routable`. | [play-dom-router/src/connect-router.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L25) |
-| <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | The route lookup that matches a URL pathname to a machine state ID.           | [play-dom-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L29) |
-| <a id="property-router"></a> `router`     | `readonly` | [`VanillaRouter`](VanillaRouter.md)             | The vanilla router from [createRouter](../functions/createRouter.md).         | [play-dom-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L27) |
+| Property                                               | Modifier   | Type                                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Inherited from                                                                                         | Defined in                                                                                                                                              |
+| ------------------------------------------------------ | ---------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                    | `readonly` | [`RoutableActor`](RoutableActor.md)             | The actor to keep in step with the browser URL. It must implement `Routable`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | -                                                                                                      | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L26) |
+| <a id="property-basepath"></a> `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](#property-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`](BasePathOptions.md).[`basePath`](BasePathOptions.md#property-basepath)             | [play-router/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L58)                   |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\>      | The values of the `:param` segments of [BasePathOptions.basePath](#property-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`](BasePathOptions.md).[`basePathParams`](BasePathOptions.md#property-basepathparams) | [play-router/src/base-path.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-path.ts#L72)                   |
+| <a id="property-routemap"></a> `routeMap`              | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | The route lookup that matches a URL pathname to a machine state ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | -                                                                                                      | [play-dom-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L30) |
+| <a id="property-router"></a> `router`                  | `readonly` | [`VanillaRouter`](VanillaRouter.md)             | The vanilla router from [createRouter](../functions/createRouter.md).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                      | [play-dom-router/src/connect-router.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L28) |

package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [play-router/src/types.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L237)
+Defined in: [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L238)
 
 The routing event, with its parameters and its query
 
@@ -128,8 +128,8 @@ analysis of the pattern.
 
 | Property                               | Modifier   | Type                           | Defined in                                                                                                                      |
 | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L242) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L240) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L241) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L239) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L238) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:243](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L243) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L241) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L242) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L240) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L239) |

package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md

@@ -2,7 +2,7 @@
 
 # Interface: RoutableActor
 
-Defined in: [play-router/src/types.ts:272](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L272)
+Defined in: [play-router/src/types.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L273)
 
 The minimal actor interface that `RouterBridgeBase` and every framework router
 adapter require.
@@ -43,8 +43,8 @@ class MyBridge extends RouterBridgeBase {
 
 | Property                                          | Modifier   | Type                                                                                         | Description                                                                                                                                                                                                                              | Defined in                                                                                                                      |
 | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [play-router/src/types.ts:274](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L274) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L280) |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L275) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L281) |
 
 ## Methods
 
@@ -54,7 +54,7 @@ class MyBridge extends RouterBridgeBase {
 send(event): void;
 ```
 
-Defined in: [play-router/src/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L282)
+Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L283)
 
 Sends a route navigation event to the actor.
 

package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteLookupContract
 
-Defined in: [play-dom-router/src/connect-router.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L15)
+Defined in: [play-dom-router/src/connect-router.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L16)
 
 The structural route lookup interface that [connectRouter](../functions/connectRouter.md) accepts.
 
@@ -21,7 +21,7 @@ that holds one form only still resolves the path.
 getPathByStateId(id): string | null | undefined;
 ```
 
-Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L17)
+Defined in: [play-dom-router/src/connect-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L18)
 
 #### Parameters
 
@@ -41,7 +41,7 @@ Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachi
 getStateIdByPath(path): string | null | undefined;
 ```
 
-Defined in: [play-dom-router/src/connect-router.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/connect-router.ts#L16)
+Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/connect-router.ts#L17)
 
 #### Parameters
 

package/api/@xmachines/play-dom-router/interfaces/RouteMap.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L105)
+Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L105)
 
 The shared base class of the route map for both directions.
 
@@ -58,7 +58,7 @@ map.getPathByStateId("missing"); // null
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L225)
+Defined in: [play-router/src/base-route-map.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L229)
 
 Returns the path pattern of a state ID.
 
@@ -94,7 +94,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L185)
+Defined in: [play-router/src/base-route-map.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L189)
 
 Resolves a URL path to its state ID.
 

package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L9)
+Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/create-route-map.ts#L9)
 
 The options of `createRouteMap` and of `createRouteMapFromTree`.
 
@@ -10,4 +10,4 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
 
 | Property                                     | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Defined in                                                                                                                                          |
 | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cachesize"></a> `cacheSize?` | `number` | The maximum number of the resolved parameterized path lookups in the cache. `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example `/profile/:userId`, with URLPattern on each call. The map keeps each path of a frequent visit in an LRU cache, and a later lookup of that path is therefore O(1). Raise this value for an application with a large set of parameterized routes, or with a high frequency of the navigation. The default is `500`. | [play-router/src/create-route-map.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L21) |
+| <a id="property-cachesize"></a> `cacheSize?` | `number` | The maximum number of the resolved parameterized path lookups in the cache. `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example `/profile/:userId`, with URLPattern on each call. The map keeps each path of a frequent visit in an LRU cache, and a later lookup of that path is therefore O(1). Raise this value for an application with a large set of parameterized routes, or with a high frequency of the navigation. The default is `500`. | [play-router/src/create-route-map.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/create-route-map.ts#L21) |

package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L54)
+Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L54)
 
 One entry of the map between a state ID and a path.
 
@@ -24,5 +24,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 | Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                      |
 | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L58) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L56) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L58) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L56) |

package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L358)
+Defined in: [play-router/src/types.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L359)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -56,7 +56,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L375)
+Defined in: [play-router/src/types.ts:376](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L376)
 
 Connects the router bridge to the Actor
 
@@ -86,7 +86,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L391)
+Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L392)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md

@@ -0,0 +1,76 @@
+[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouterConnection
+
+# Interface: RouterConnection()
+
+Defined in: [play-router/src/provider-lifecycle.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L263)
+
+What `connectRouter` of an adapter returns.
+
+The value is CALLABLE, so `const disconnect = connectRouter(…); disconnect();` keeps
+working exactly as it did. It also carries the mount API, because a host that gives a
+`basePath` needs the two things [MountableRouterBridge](../../play-router/interfaces/MountableRouterBridge.md) promises: the resolved
+mount to read back, and a way to move it. The bridge itself lives inside
+`connectRouter`, so without this handle a host had to rebuild the actor and the bridge
+to move a mount — which throws away the LRU cache of the route map, the very thing
+`setBasePath` exists to keep.
+
+`basePath` and `basePathParams` are GETTERS on the live bridge, so they cannot go
+stale.
+
+```ts
+RouterConnection(): void;
+```
+
+Defined in: [play-router/src/provider-lifecycle.ts:265](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L265)
+
+Stops the synchronization. The same call as [RouterConnection.disconnect](#disconnect).
+
+## Returns
+
+`void`
+
+## Properties
+
+| Property                                              | Modifier   | Type                                         | Description                                                                       | Defined in                                                                                                                                                |
+| ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L269) |
+| <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event.        | [play-router/src/provider-lifecycle.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L271) |
+
+## Methods
+
+### disconnect()
+
+```ts
+disconnect(): void;
+```
+
+Defined in: [play-router/src/provider-lifecycle.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L267)
+
+Stops the synchronization.
+
+#### Returns
+
+`void`
+
+---
+
+### setBasePath()
+
+```ts
+setBasePath(basePath?, basePathParams?): void;
+```
+
+Defined in: [play-router/src/provider-lifecycle.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L273)
+
+Moves the mount of the live bridge, with no teardown.
+
+#### Parameters
+
+| Parameter         | Type                                       |
+| ----------------- | ------------------------------------------ |
+| `basePath?`       | `string`                                   |
+| `basePathParams?` | `Record`\<`string`, `string` \| `number`\> |
+
+#### Returns
+
+`void`

package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md

@@ -2,14 +2,14 @@
 
 # Interface: VanillaRouter
 
-Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-router.ts#L4)
+Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-router.ts#L4)
 
 ## Properties
 
 | Property                                    | Modifier   | Type                                                     | Description                                     | Defined in                                                                                                                                            |
 | ------------------------------------------- | ---------- | -------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`     | `readonly` | [`BrowserHistory`](BrowserHistory.md)                    | The history instance                            | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-router.ts#L8)   |
-| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-router.ts#L13) |
+| <a id="property-history"></a> `history`     | `readonly` | [`BrowserHistory`](BrowserHistory.md)                    | The history instance                            | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-router.ts#L8)   |
+| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-router.ts#L13) |
 
 ## Methods
 
@@ -19,7 +19,7 @@ Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-
 destroy(): void;
 ```
 
-Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-router.ts#L18)
+Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom-router/src/create-router.ts#L18)
 
 Cleans up
 

package/api/@xmachines/play-react/README.md

@@ -4,7 +4,7 @@
 
 React renderer for XMachines Play architecture with signal-driven rendering.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.1-blue)](https://www.npmjs.com/package/@xmachines/play-react)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.2.0-blue)](https://www.npmjs.com/package/@xmachines/play-react)
 
 ## Installation
 

package/api/@xmachines/play-react/classes/PlayErrorBoundary.md

@@ -2,7 +2,7 @@
 
 # Class: PlayErrorBoundary
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L54)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L54)
 
 The React class component that catches a render error of a catalog component.
 
@@ -37,7 +37,7 @@ CONS-14: the class component pattern works with every React version, 18 and 19.
 new PlayErrorBoundary(props): PlayErrorBoundary;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L58)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L58)
 
 #### Parameters
 
@@ -76,7 +76,7 @@ React.Component<
 componentDidCatch(error, info): void;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L67)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L67)
 
 Catches exceptions generated in descendant components. Unhandled exceptions will cause
 the entire component tree to unmount.
@@ -376,7 +376,7 @@ React.Component.getSnapshotBeforeUpdate;
 render(): ReactNode;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L71)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L71)
 
 #### Returns
 
@@ -605,7 +605,7 @@ React.Component.UNSAFE_componentWillUpdate;
 static getDerivedStateFromError(error): PlayErrorBoundaryState;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L63)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L63)
 
 #### Parameters
 

package/api/@xmachines/play-react/functions/useActor.md

@@ -6,7 +6,7 @@
 function useActor(): AnyPlayActor;
 ```
 
-Defined in: [packages/play-react/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/useActor.ts#L34)
+Defined in: [packages/play-react/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/useActor.ts#L34)
 
 ## Returns
 

package/api/@xmachines/play-react/functions/usePlayView.md

@@ -6,7 +6,7 @@
 function usePlayView(): ViewContextValue;
 ```
 
-Defined in: [packages/play-react/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L94)
+Defined in: [packages/play-react/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/ActorProvider.tsx#L94)
 
 The hook that gives the current view spec, the handlers, and the registry.
 

package/api/@xmachines/play-react/functions/useSignalEffect.md

@@ -6,7 +6,7 @@
 function useSignalEffect(callback, deps?): void;
 ```
 
-Defined in: [packages/play-react/src/useSignalEffect.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/useSignalEffect.ts#L81)
+Defined in: [packages/play-react/src/useSignalEffect.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/useSignalEffect.ts#L81)
 
 The React hook that subscribes to the signal changes and runs an effect callback
 

package/api/@xmachines/play-react/interfaces/ActorProviderProps.md

@@ -2,7 +2,7 @@
 
 # Interface: ActorProviderProps
 
-Defined in: [packages/play-react/src/ActorProvider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L53)
+Defined in: [packages/play-react/src/ActorProvider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/ActorProvider.tsx#L53)
 
 The props of the ActorProvider component.
 
@@ -18,10 +18,10 @@ The props of the ActorProvider component.
 
 | Property                                              | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                                                      | Defined in                                                                                                                                               |
 | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L163) |
-| <a id="property-children"></a> `children`             | `ReactNode`                                                                                                                                                                                                                                                      | The child components to render inside the provider tree                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L59)   |
-| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                                                                                                                                                                                                                      | The component to show when currentView is null, or when a catalog component throws. This prop is optional                                                                                                                                                                         | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L55)   |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `info`) => `void`                                                                                                                                                                                                                                      | The optional error handler. The provider calls it when a catalog component throws during a render                                                                                                                                                                                 | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L57)   |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L177) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L165) |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L163) |
+| <a id="property-children"></a> `children`             | `ReactNode`                                                                                                                                                                                                                                                      | The child components to render inside the provider tree                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/ActorProvider.tsx#L59)   |
+| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                                                                                                                                                                                                                      | The component to show when currentView is null, or when a catalog component throws. This prop is optional                                                                                                                                                                         | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/ActorProvider.tsx#L55)   |
+| <a id="property-onerror"></a> `onError?`              | (`error`, `info`) => `void`                                                                                                                                                                                                                                      | The optional error handler. The provider calls it when a catalog component throws during a render                                                                                                                                                                                 | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/ActorProvider.tsx#L57)   |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L177) |
+| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L165) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L172) |

package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayErrorBoundaryProps
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L14)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L14)
 
 The props of PlayErrorBoundary
 
@@ -10,6 +10,6 @@ The props of PlayErrorBoundary
 
 | Property                                   | Type                        | Description                                                                              | Defined in                                                                                                                                                     |
 | ------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-children"></a> `children`  | `ReactNode`                 | The child components to render                                                           | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
-| <a id="property-fallback"></a> `fallback?` | `ReactNode`                 | The fallback UI to render when a child component throws. The default is null.            | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
-| <a id="property-onerror"></a> `onError?`   | (`error`, `info`) => `void` | The optional error handler. It sends each error to an observability tool, such as Sentry | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
+| <a id="property-children"></a> `children`  | `ReactNode`                 | The child components to render                                                           | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
+| <a id="property-fallback"></a> `fallback?` | `ReactNode`                 | The fallback UI to render when a child component throws. The default is null.            | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
+| <a id="property-onerror"></a> `onError?`   | (`error`, `info`) => `void` | The optional error handler. It sends each error to an observability tool, such as Sentry | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |

package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayErrorBoundaryState
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L28)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L28)
 
 The internal state shape of PlayErrorBoundary
 
@@ -10,5 +10,5 @@ The internal state shape of PlayErrorBoundary
 
 | Property                                  | Type              | Defined in                                                                                                                                                     |
 | ----------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-error"></a> `error`       | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
-| <a id="property-haserror"></a> `hasError` | `boolean`         | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
+| <a id="property-error"></a> `error`       | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
+| <a id="property-haserror"></a> `hasError` | `boolean`         | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-react/src/PlayErrorBoundary.tsx#L29) |