@xmachines/docs 5.0.2 → 6.1.0

package/api/@xmachines/play-vue/variables/schema.md

@@ -4,60 +4,41 @@
 
 ```ts
 const schema: _json_render_core.Schema<{
-	catalog: _json_render_core.SchemaType<
-		"object",
-		{
-			actions: _json_render_core.SchemaType<
-				"map",
-				{
-					description: _json_render_core.SchemaType<"string", unknown>;
-					params: _json_render_core.SchemaType<"zod", unknown>;
-				}
-			>;
-			components: _json_render_core.SchemaType<
-				"map",
-				{
-					description: _json_render_core.SchemaType<"string", unknown>;
-					example: _json_render_core.SchemaType<"any", unknown>;
-					props: _json_render_core.SchemaType<"zod", unknown>;
-					slots: _json_render_core.SchemaType<
-						"array",
-						_json_render_core.SchemaType<"string", unknown>
-					>;
-				}
-			>;
-		}
-	>;
-	spec: _json_render_core.SchemaType<
-		"object",
-		{
-			elements: _json_render_core.SchemaType<
-				"record",
-				_json_render_core.SchemaType<
-					"object",
-					{
-						children: _json_render_core.SchemaType<
-							"array",
-							_json_render_core.SchemaType<"string", unknown>
-						>;
-						props: _json_render_core.SchemaType<"propsOf", string>;
-						repeat: {
-							inner?: unknown;
-							kind: "any";
-							optional: true;
-						};
-						type: _json_render_core.SchemaType<"ref", string>;
-						visible: {
-							inner?: unknown;
-							kind: "any";
-							optional: true;
-						};
-					}
-				>
-			>;
-			root: _json_render_core.SchemaType<"string", unknown>;
-		}
-	>;
+  catalog: _json_render_core.SchemaType<"object", {
+     actions: _json_render_core.SchemaType<"map", {
+        description: _json_render_core.SchemaType<"string", unknown>;
+        params: _json_render_core.SchemaType<"zod", unknown>;
+     }>;
+     components: _json_render_core.SchemaType<"map", {
+        description: _json_render_core.SchemaType<"string", unknown>;
+        example: _json_render_core.SchemaType<"any", unknown>;
+        props: _json_render_core.SchemaType<"zod", unknown>;
+        slots: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<"string", unknown>>;
+     }>;
+  }>;
+  spec: _json_render_core.SchemaType<"object", {
+     elements: _json_render_core.SchemaType<"record", _json_render_core.SchemaType<"object", {
+        children: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<"string", unknown>>;
+        props: _json_render_core.SchemaType<"propsOf", string>;
+        repeat: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+        slots: {
+           inner?: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<..., ...>>;
+           kind: "record";
+           optional: true;
+        };
+        type: _json_render_core.SchemaType<"ref", string>;
+        visible: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+     }>>;
+     root: _json_render_core.SchemaType<"string", unknown>;
+  }>;
 }>;
 ```
 

package/api/@xmachines/play-vue-router/README.md

@@ -4,14 +4,16 @@
 
 Vue Router 4/5 adapter for the XMachines Universal Player Architecture. It keeps Vue Router and an XMachines state machine in step, in both directions, with the reactive primitives of Vue.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-vue-router)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-vue-router)
 
 ## Installation
 
 ```bash
-pnpm add @xmachines/play-vue-router @xmachines/play-router @xmachines/play
+pnpm add @xmachines/play-vue-router @xmachines/play-router @xmachines/core @xmachines/play @xmachines/play-atom
 ```
 
+[`@xmachines/play-router`](../play-router/README.md) names [`@xmachines/core`](../core/README.md), [`@xmachines/play`](../play/README.md) and [`@xmachines/play-atom`](../play-atom/README.md) as peers, so the command installs them with this package.
+
 **Peer dependencies:**
 
 - [`@xmachines/play`](../play/README.md) — the core protocol. This package reads the error classes from its `errors` subpath.

package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md

@@ -2,7 +2,7 @@
 
 # Class: VueRouterNavigationError
 
-Defined in: [packages/play-vue-router/src/errors.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/errors.ts#L26)
+Defined in: [packages/play-vue-router/src/errors.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/errors.ts#L26)
 
 The bridge throws this error when Vue Router cannot navigate to the path or to
 the state ID that the actor requested.
@@ -39,7 +39,7 @@ try {
 new VueRouterNavigationError(message, options?): VueRouterNavigationError;
 ```
 
-Defined in: [packages/play-vue-router/src/errors.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/errors.ts#L27)
+Defined in: [packages/play-vue-router/src/errors.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/errors.ts#L27)
 
 #### Parameters
 
@@ -61,10 +61,10 @@ Defined in: [packages/play-vue-router/src/errors.ts:27](https://gitlab.com/xmach
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                          |
 

package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md

@@ -2,7 +2,7 @@
 
 # Class: VueRouterSendError
 
-Defined in: [packages/play-vue-router/src/errors.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/errors.ts#L41)
+Defined in: [packages/play-vue-router/src/errors.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/errors.ts#L41)
 
 The bridge throws this error when its Vue Router `afterEach` hook cannot build
 or send the `play.route` event to the actor after a navigation that succeeded.
@@ -23,7 +23,7 @@ The `cause` property holds the error below it.
 new VueRouterSendError(message, options?): VueRouterSendError;
 ```
 
-Defined in: [packages/play-vue-router/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/errors.ts#L42)
+Defined in: [packages/play-vue-router/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/errors.ts#L42)
 
 #### Parameters
 
@@ -45,10 +45,10 @@ Defined in: [packages/play-vue-router/src/errors.ts:42](https://gitlab.com/xmach
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                          |
 

package/api/@xmachines/play-vue-router/index/classes/RouteMap.md

@@ -2,7 +2,7 @@
 
 # Class: RouteMap
 
-Defined in: [packages/play-router/src/base-route-map.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L177)
+Defined in: [packages/play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L176)
 
 The shared base class of the route map for both directions.
 
@@ -15,8 +15,7 @@ of its own, and it inherits the complete public API from here.
 - A dynamic path → a scan of the bucket index in O(k), with `URLPattern`, where
   `k` is the number of the routes with the same first path segment
 - The class keeps each result of a first match in an LRU cache. The default cache
-  holds between 500 and 1000 entries, and the `pathCache` constructor option
-  replaces it
+  holds 1001 entries at most, and the `pathCache` constructor option replaces it
 
 **The syntax of a pattern:** the whole URLPattern pathname grammar. The forms used most
 often are:
@@ -65,7 +64,7 @@ map.getPathByStateId("missing"); // null
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [packages/play-router/src/base-route-map.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L210)
+Defined in: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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.
 
@@ -93,7 +92,7 @@ candidates is therefore efficient.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [packages/play-router/src/base-route-map.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L324)
+Defined in: [packages/play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L322)
 
 Returns the path pattern of a state ID.
 
@@ -129,7 +128,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [packages/play-router/src/base-route-map.ts:279](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L279)
+Defined in: [packages/play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L277)
 
 Resolves a URL path to its state ID.
 

package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md

@@ -2,7 +2,7 @@
 
 # Class: VueRouterBridge
 
-Defined in: [packages/play-vue-router/src/vue-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/vue-router-bridge.ts#L39)
+Defined in: [packages/play-vue-router/src/vue-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/vue-router-bridge.ts#L39)
 
 @xmachines/play-vue-router - Vue Router 4/5 adapter for XMachines Play
 
@@ -25,7 +25,7 @@ new VueRouterBridge(
 ): VueRouterBridge;
 ```
 
-Defined in: [packages/play-vue-router/src/vue-router-bridge.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/vue-router-bridge.ts#L48)
+Defined in: [packages/play-vue-router/src/vue-router-bridge.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/vue-router-bridge.ts#L48)
 
 #### Parameters
 
@@ -54,7 +54,7 @@ Defined in: [packages/play-vue-router/src/vue-router-bridge.ts:48](https://gitla
 get basePath(): string;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L282)
+Defined in: [packages/play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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.
@@ -79,7 +79,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
 get basePathParams(): Readonly<Record<string, string>>;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L311)
+Defined in: [packages/play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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.
@@ -130,7 +130,7 @@ mount while the machine stays on the same route, and no event goes out.
 connect(): void;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L533)
+Defined in: [packages/play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L533)
 
 Connects the router bridge to the Actor.
 
@@ -164,7 +164,7 @@ An adapter that needs a different behavior of the first synchronization override
 disconnect(): void;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L791)
+Defined in: [packages/play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L791)
 
 Disconnects the router bridge from the Actor.
 
@@ -187,7 +187,7 @@ framework.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L351)
+Defined in: [packages/play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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-vue-router/index/interfaces/PlayRouteEvent.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayRouteEvent
 
-Defined in: [packages/play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L336)
+Defined in: [packages/play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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. | [packages/play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L346) |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                           | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L347) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L339) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L340) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                                                            | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L338) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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. | [packages/play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L346) |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                                                           | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L347) |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L339) |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\>                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L340) |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                                                            | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L338) |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                                                      | -                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L337) |

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

@@ -2,7 +2,7 @@
 
 # Interface: RoutableActor
 
-Defined in: [packages/play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L392)
+Defined in: [packages/play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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) | [packages/play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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) | [packages/play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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) | [packages/play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.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) | [packages/play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L355) |
 
 ## Methods
 
@@ -57,7 +57,7 @@ class MyBridge extends RouterBridgeBase {
 send(event): void;
 ```
 
-Defined in: [packages/play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L394)
+Defined in: [packages/play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L394)
 
 Sends a route navigation event to the actor.
 

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

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [packages/play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L565)
+Defined in: [packages/play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L565)
 
 The options of `createRouteMap` and of `createRouteMapFromTree`.
 
@@ -12,8 +12,8 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
 
 ## Properties
 
-| Property                                             | Modifier   | Type                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                                                | Defined in                                                                                                                                                 |
-| ---------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](../../../play-router/index/interfaces/PatternCache.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) | [packages/play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L119) |
-| <a id="property-pathcache"></a> `pathCache?`         | `public`   | [`PatternCache`](../../../play-router/index/interfaces/PatternCache.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, of 500 entries in each of two generations. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createPatternCache(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. | -                                                                                                                                                                             | [packages/play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L584)                   |
-| <a id="property-patterncache"></a> `patternCache?`   | `readonly` | [`PatternCache`](../../../play-router/index/interfaces/PatternCache.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)   | [packages/play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L40)                   |
+| 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) | [packages/play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.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. | -                                                                                                                                                                             | [packages/play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.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)   | [packages/play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/cache.ts#L41)                   |

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

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

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

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L436)
+Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -22,10 +22,10 @@ The implementation of a framework router bridge
 
 ```typescript
 import type { RouterBridge } from "@xmachines/play-router";
-import { watchAtom, type Cleanup } from "@xmachines/play-atom";
+import { watchAtom } from "@xmachines/play-atom";
 
 class MyRouterBridge implements RouterBridge {
-	private stop: Cleanup | null = null;
+	private stop: (() => void) | null = null;
 
 	async connect(): Promise<void> {
 		// Start the observation of the actor.currentRoute atom
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L453)
+Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L469)
+Defined in: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md

@@ -22,12 +22,12 @@ const PlayRouterProvider: DefineComponent<
 		compiledCache: {
 			default: undefined;
 			required: false;
-			type: PropType<PatternCache<URLPatternLike>>;
+			type: PropType<KeyValueCache<URLPatternLike>>;
 		};
 		patternCache: {
 			default: undefined;
 			required: false;
-			type: PropType<PatternCache<ParsedPattern>>;
+			type: PropType<KeyValueCache<ParsedPattern>>;
 		};
 		renderer: {
 			required: true;
@@ -70,12 +70,12 @@ const PlayRouterProvider: DefineComponent<
 			compiledCache: {
 				default: undefined;
 				required: false;
-				type: PropType<PatternCache<URLPatternLike>>;
+				type: PropType<KeyValueCache<URLPatternLike>>;
 			};
 			patternCache: {
 				default: undefined;
 				required: false;
-				type: PropType<PatternCache<ParsedPattern>>;
+				type: PropType<KeyValueCache<ParsedPattern>>;
 			};
 			renderer: {
 				required: true;
@@ -95,8 +95,8 @@ const PlayRouterProvider: DefineComponent<
 	{
 		basePath: string;
 		basePathParams: Record<string, string | number>;
-		compiledCache: PatternCache<URLPatternLike>;
-		patternCache: PatternCache<ParsedPattern>;
+		compiledCache: KeyValueCache<URLPatternLike>;
+		patternCache: KeyValueCache<ParsedPattern>;
 	},
 	{},
 	{},
@@ -109,7 +109,7 @@ const PlayRouterProvider: DefineComponent<
 >;
 ```
 
-Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue-router/src/play-router-provider.ts#L18)
+Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/play-router-provider.ts#L18)
 
 PlayRouterProvider — the Vue wrapper of VueRouterBridge.