@xmachines/docs 7.1.0 → 7.3.0

package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: SvelteKitRouterBridgeOptions
 
-Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L41)
+Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L41)
 
 The options of [SvelteKitRouterBridge](../classes/SvelteKitRouterBridge.md).
 
@@ -18,8 +18,8 @@ The options of [SvelteKitRouterBridge](../classes/SvelteKitRouterBridge.md).
 
 | Property                                               | Modifier   | Type                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Inherited from                                                                                                                                                                           | Defined in                                                                                                                                                                                 |
 | ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <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](../../play-router/index/interfaces/BasePathOptions.md#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".                                                                                                                     | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePath`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepath)             | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L62)                                                       |
-| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\>                                                                                                           | The values of the `:param` segments of [BasePathOptions.basePath](../../play-router/index/interfaces/BasePathOptions.md#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. | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePathParams`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepathparams) | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L76)                                                       |
-| <a id="property-compiledcache"></a> `compiledCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                      | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`compiledCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-compiledcache)   | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/url-pattern-utils.ts#L119)                                     |
-| <a id="property-patterncache"></a> `patternCache?`     | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`patternCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-patterncache)     | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L41)                                                       |
-| <a id="property-shallow"></a> `shallow?`               | `readonly` | [`ShallowNavigation`](../type-aliases/ShallowNavigation.md)                                                                                          | What the bridge does with a shallow navigation. The default is `"ignore"`. **See** [ShallowNavigation](../type-aliases/ShallowNavigation.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                                                        | [play-sveltekit-router/src/sveltekit-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L47) |
+| <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](../../play-router/index/interfaces/BasePathOptions.md#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".                                                                                                                     | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePath`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepath)             | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L62)                                                       |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\>                                                                                                           | The values of the `:param` segments of [BasePathOptions.basePath](../../play-router/index/interfaces/BasePathOptions.md#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. | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePathParams`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepathparams) | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L76)                                                       |
+| <a id="property-compiledcache"></a> `compiledCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                      | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`compiledCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-compiledcache)   | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L119)                                     |
+| <a id="property-patterncache"></a> `patternCache?`     | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`patternCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-patterncache)     | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/cache.ts#L41)                                                       |
+| <a id="property-shallow"></a> `shallow?`               | `readonly` | [`ShallowNavigation`](../type-aliases/ShallowNavigation.md)                                                                                          | What the bridge does with a shallow navigation. The default is `"ignore"`. **See** [ShallowNavigation](../type-aliases/ShallowNavigation.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                                                        | [play-sveltekit-router/src/sveltekit-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L47) |

package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md

@@ -6,7 +6,7 @@
 type ShallowNavigation = "ignore" | "sync";
 ```
 
-Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L38)
+Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L38)
 
 What the bridge does with a shallow navigation of SvelteKit: `goto(url, { shallow: true })`,
 `pushState`, `replaceState`, and a back or forward step between shallow entries.

package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L176)
+Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L176)
 
 The shared base class of the route map for both directions.
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L209)
 
 Builds a route map from an array of the mappings between a state ID and a path.
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L322)
+Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L322)
 
 Returns the path pattern of a state ID.
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L277)
+Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L277)
 
 Resolves a URL path to its state ID.
 

package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md

@@ -2,7 +2,7 @@
 
 # Class: TanStackReactRouterBridge
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
 
 The shared TanStack Router adapter. It implements the RouterBridge protocol through RouterBridgeBase
 
@@ -56,7 +56,7 @@ new TanStackReactRouterBridge(
 ): TanStackRouterBridgeBase;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
 
 Creates a TanStack Router bridge
 
@@ -87,7 +87,7 @@ Creates a TanStack Router bridge
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L282)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -112,7 +112,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L311)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -163,7 +163,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -197,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L795)
+Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L795)
 
 Disconnects the router bridge from the Actor.
 
@@ -220,7 +220,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L351)
 
 Moves the machine to a different mount point, while it stays connected.
 

package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md

@@ -8,7 +8,7 @@ function createPlayRouterProvider<TRouter, TActorBase>(
 ): <TActor>(__namedParameters) => Element;
 ```
 
-Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L52)
+Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L52)
 
 Builds a `PlayRouterProvider` for one React bridge class.
 

package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md

@@ -6,7 +6,7 @@
 function createRouteMapFromTree(routeTree, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/create-route-map-from-tree.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/create-route-map-from-tree.ts#L40)
+Defined in: [play-router/src/create-route-map-from-tree.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/create-route-map-from-tree.ts#L40)
 
 Creates a `RouteMap` from the node structure of a `RouteTree`.
 

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

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L336)
+Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L336)
 
 The routing event, with its parameters and its query
 
@@ -122,9 +122,9 @@ analysis of the pattern.
 
 | Property                               | Modifier   | Type                                                             | Description                                                                                                                                                                                                                                                                           | Defined in                                                                                                                           |
 | -------------------------------------- | ---------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L346) |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                        | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L347) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L339) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L340) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                                                         | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L338) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L337) |
+| <a id="property-data"></a> `data?`     | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L346) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                        | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L347) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L339) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L340) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                                                         | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L338) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                   | -                                                                                                                                                                                                                                                                                     | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L337) |

package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouterProviderProps\<TActor\>
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L45)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L45)
 
 The props of the `PlayRouterProvider` of TanStack React Router.
 
@@ -24,11 +24,11 @@ The props of the `PlayRouterProvider` of TanStack React Router.
 
 | Property                                               | Modifier   | Type                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Inherited from                               | Defined in                                                                                                                                                   |
 | ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-actor"></a> `actor`                    | `public`   | `TActor`                                                                                                                                             | The actor to keep in step with the router. It must be a stable reference: give the same actor instance on every render. An actor in the JSX, or a new actor on each render, makes the bridge disconnect and connect again each time.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `PlayRouterProviderBaseProps.actor`          | [play-router/src/provider-lifecycle.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L46) |
-| <a id="property-basepath"></a> `basePath?`             | `public`   | `string`                                                                                                                                             | Mounts the routes of the machine under a URL prefix that the host owns, so that the routes of the host and the routes of the machine share one router. `actor`, `router`, and `routeMap` each need a stable reference. This prop needs none, and it rebuilds the bridge never: a change moves the live bridge with `setBasePath()`, so a host route that renders again with a new prefix keeps the actor, the route map, and its cache. The prefix says WHERE an actor is mounted, and never WHICH actor is mounted. An actor never changes identity, so a prefix segment that IDENTIFIES the actor gives a different `actor` prop instead, and THAT rebuilds the bridge — which is correct, because one actor takes one bridge. A location outside the prefix belongs completely to the host: the bridge sends no event there, and it corrects no URL there. Every `:param` needs a value. An unresolved one throws a `MissingBasePathParamError` out of the mount effect, because the bridge writes no URL without it. Render this component only after the host holds the value, which a route loader or a `useParams()` call does already. | `PlayRouterProviderBaseProps.basePath`       | [play-router/src/provider-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L84) |
-| <a id="property-basepathparams"></a> `basePathParams?` | `public`   | `Record`\<`string`, `string` \| `number`\>                                                                                                           | The values of the `:param` segments of [PlayRouterProviderBaseProps.basePath](../../play-react-router/interfaces/PlayRouterProviderProps.md#property-basepath), for example `{ machineId }` for `basePath="/:machineId/play"`. An inline object literal is correct here: the provider compares this prop by value, and a move to the same prefix does nothing.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `PlayRouterProviderBaseProps.basePathParams` | [play-router/src/provider-lifecycle.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L93) |
-| <a id="property-compiledcache"></a> `compiledCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `PlayRouterProviderBaseProps.compiledCache`  | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/url-pattern-utils.ts#L119)       |
-| <a id="property-patterncache"></a> `patternCache?`     | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `PlayRouterProviderBaseProps.patternCache`   | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L41)                         |
-| <a id="property-renderer"></a> `renderer`              | `public`   | (`actor`, `router`) => `ReactNode`                                                                                                                   | The renderer callback receives the same concrete actor type as the prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `PlayRouterProviderBaseProps.renderer`       | [play-router/src/provider-lifecycle.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L95) |
-| <a id="property-routemap"></a> `routeMap`              | `public`   | [`RouteMap`](../classes/RouteMap.md)                                                                                                                 | The route map of both directions, for the lookup between a state ID and a URL path. **It must be a stable reference.** The provider builds the bridge again on each change of the identity of `routeMap`. A value in the JSX, for example `createRouteMapFromTree(routeTree)`, makes a new object on every render, and the bridge therefore connects again on every render. Hold the value with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `PlayRouterProviderBaseProps.routeMap`       | [play-router/src/provider-lifecycle.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L61) |
-| <a id="property-router"></a> `router`                  | `public`   | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                                                                                        | The router instance that the bridge keeps in step with the actor. It must be a stable reference.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | `PlayRouterProviderBaseProps.router`         | [play-router/src/provider-lifecycle.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L48) |
+| <a id="property-actor"></a> `actor`                    | `public`   | `TActor`                                                                                                                                             | The actor to keep in step with the router. It must be a stable reference: give the same actor instance on every render. An actor in the JSX, or a new actor on each render, makes the bridge disconnect and connect again each time.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `PlayRouterProviderBaseProps.actor`          | [play-router/src/provider-lifecycle.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L46) |
+| <a id="property-basepath"></a> `basePath?`             | `public`   | `string`                                                                                                                                             | Mounts the routes of the machine under a URL prefix that the host owns, so that the routes of the host and the routes of the machine share one router. `actor`, `router`, and `routeMap` each need a stable reference. This prop needs none, and it rebuilds the bridge never: a change moves the live bridge with `setBasePath()`, so a host route that renders again with a new prefix keeps the actor, the route map, and its cache. The prefix says WHERE an actor is mounted, and never WHICH actor is mounted. An actor never changes identity, so a prefix segment that IDENTIFIES the actor gives a different `actor` prop instead, and THAT rebuilds the bridge — which is correct, because one actor takes one bridge. A location outside the prefix belongs completely to the host: the bridge sends no event there, and it corrects no URL there. Every `:param` needs a value. An unresolved one throws a `MissingBasePathParamError` out of the mount effect, because the bridge writes no URL without it. Render this component only after the host holds the value, which a route loader or a `useParams()` call does already. | `PlayRouterProviderBaseProps.basePath`       | [play-router/src/provider-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L84) |
+| <a id="property-basepathparams"></a> `basePathParams?` | `public`   | `Record`\<`string`, `string` \| `number`\>                                                                                                           | The values of the `:param` segments of [PlayRouterProviderBaseProps.basePath](../../play-react-router/interfaces/PlayRouterProviderProps.md#property-basepath), for example `{ machineId }` for `basePath="/:machineId/play"`. An inline object literal is correct here: the provider compares this prop by value, and a move to the same prefix does nothing.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `PlayRouterProviderBaseProps.basePathParams` | [play-router/src/provider-lifecycle.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L93) |
+| <a id="property-compiledcache"></a> `compiledCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `PlayRouterProviderBaseProps.compiledCache`  | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L119)       |
+| <a id="property-patterncache"></a> `patternCache?`     | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `PlayRouterProviderBaseProps.patternCache`   | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/cache.ts#L41)                         |
+| <a id="property-renderer"></a> `renderer`              | `public`   | (`actor`, `router`) => `ReactNode`                                                                                                                   | The renderer callback receives the same concrete actor type as the prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `PlayRouterProviderBaseProps.renderer`       | [play-router/src/provider-lifecycle.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L95) |
+| <a id="property-routemap"></a> `routeMap`              | `public`   | [`RouteMap`](../classes/RouteMap.md)                                                                                                                 | The route map of both directions, for the lookup between a state ID and a URL path. **It must be a stable reference.** The provider builds the bridge again on each change of the identity of `routeMap`. A value in the JSX, for example `createRouteMapFromTree(routeTree)`, makes a new object on every render, and the bridge therefore connects again on every render. Hold the value with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `PlayRouterProviderBaseProps.routeMap`       | [play-router/src/provider-lifecycle.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L61) |
+| <a id="property-router"></a> `router`                  | `public`   | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                                                                                        | The router instance that the bridge keeps in step with the actor. It must be a stable reference.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | `PlayRouterProviderBaseProps.router`         | [play-router/src/provider-lifecycle.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L48) |

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

@@ -2,7 +2,7 @@
 
 # Interface: RoutableActor
 
-Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L392)
+Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L392)
 
 The minimal actor interface that `RouterBridgeBase` and every framework router
 adapter require.
@@ -46,8 +46,8 @@ class MyBridge extends RouterBridgeBase {
 
 | Property                                          | Modifier   | Type                                                                               | Inherited from                                                                                                                                      | Defined in                                                                                                                           |
 | ------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../play-router/index/interfaces/Routable.md#property-currentroute) | [play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L354) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                 | [`Routable`](../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../play-router/index/interfaces/Routable.md#property-initialroute) | [play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L355) |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../play-router/index/interfaces/Routable.md#property-currentroute) | [play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L354) |
+| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                 | [`Routable`](../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../play-router/index/interfaces/Routable.md#property-initialroute) | [play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L355) |
 
 ## Methods
 
@@ -57,7 +57,7 @@ class MyBridge extends RouterBridgeBase {
 send(event): void;
 ```
 
-Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L394)
+Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L394)
 
 Sends a route navigation event to the actor.
 

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

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L565)
+Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L565)
 
 The options of `createRouteMap` and of `createRouteMapFromTree`.
 
@@ -14,6 +14,6 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
 
 | Property                                             | Modifier   | Type                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Inherited from                                                                                                                                                          | Defined in                                                                                                                                             |
 | ---------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                       | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/url-pattern-utils.ts#L119) |
-| <a id="property-pathcache"></a> `pathCache?`         | `public`   | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<`string` \| `null`\>                                                         | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone. It keeps two generations, and it holds 1001 entries at most. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createLruCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | -                                                                                                                                                                       | [play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L584)                   |
-| <a id="property-patterncache"></a> `patternCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../play-router/index/interfaces/CompileOptions.md#property-patterncache)   | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L41)                   |
+| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern.                                                                                                                                                                                                                                                                                                                                                                       | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L119) |
+| <a id="property-pathcache"></a> `pathCache?`         | `public`   | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<`string` \| `null`\>                                                         | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone. It keeps two generations, and it holds 1001 entries at most. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createLruCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | -                                                                                                                                                                       | [play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L584)                   |
+| <a id="property-patterncache"></a> `patternCache?`   | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\>     | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../play-router/index/interfaces/CompileOptions.md#property-patterncache)   | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/cache.ts#L41)                   |

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

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L58)
+Defined in: [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L58)
 
 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:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L62) |
-| <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:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L60) |
+| <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:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L62) |
+| <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:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/base-route-map.ts#L60) |

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

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L436)
+Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L453)
+Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L453)
 
 Connects the router bridge to the Actor
 
@@ -84,7 +84,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L469)
+Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md

@@ -11,7 +11,7 @@ type PlayRouterBridgeConstructor<TRouter, TActor> = new (
 ) => RouterBridge;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L118)
+Defined in: [play-router/src/provider-lifecycle.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/provider-lifecycle.ts#L118)
 
 The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md

@@ -10,7 +10,7 @@ type PlayRouterProviderBaseProps<TRouter, TActor> = PlayRouterProviderBaseProps<
 >;
 ```
 
-Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L35)
+Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L35)
 
 The props of a React `PlayRouterProvider`.
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md

@@ -6,4 +6,4 @@
 type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L36)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L36)

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md

@@ -6,7 +6,7 @@
 type TanStackRouterLike = object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L40)
 
 The type-only interface of the TanStack Router surface that
 `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
 history: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L73)
 
 #### location
 
@@ -69,7 +69,7 @@ subscribe(handler): () => void;
 options?: object;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L59)
 
 The options of the router. The bridge reads `parseSearch` only.
 
@@ -103,7 +103,7 @@ parseSearch ? search : Record<string, unknown>;
 load?(): void | Promise<void>;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
 
 Runs the TanStack route matching and the loaders again for the current location.
 This method is optional. The bridge calls it after every navigation. The matching
@@ -128,7 +128,7 @@ bridge then synchronizes synchronously.
 navigate(args): void;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L49)
 
 Navigates to a location. `search` carries the query of the target.
 

package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md

@@ -6,7 +6,7 @@
 const PlayRouterProvider: <TActor>(__namedParameters) => Element;
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L60)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-react-router/src/play-router-provider.tsx#L60)
 
 Connects a `PlayerActor` to TanStack React Router. It keeps the actor state and the
 browser URL in step, in both directions.

package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md

@@ -2,7 +2,7 @@
 
 # Class: TanStackRouterBridgeBase
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L134)
 
 The shared TanStack Router adapter. It implements the RouterBridge protocol through RouterBridgeBase
 
@@ -56,7 +56,7 @@ new TanStackRouterBridgeBase(
 ): TanStackRouterBridgeBase;
 ```
 
-Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L152)
 
 Creates a TanStack Router bridge
 
@@ -87,7 +87,7 @@ Creates a TanStack Router bridge
 get basePath(): string;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L282)
 
 The resolved URL prefix that the machine of this bridge is mounted under, or `""`
 when the machine owns the complete router.
@@ -112,7 +112,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L311)
 
 The resolved values of the `:param` segments of the mount, or `{}` for a prefix
 without a param.
@@ -163,7 +163,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -197,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L795)
+Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L795)
 
 Disconnects the router bridge from the Actor.
 
@@ -220,7 +220,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/router-bridge-base.ts#L351)
 
 Moves the machine to a different mount point, while it stays connected.