@xmachines/docs 5.0.2 → 6.0.0

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

@@ -2,7 +2,7 @@
 
 # Interface: ConnectRouterOptions
 
-Defined in: [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/connect-router.ts#L24)
+Defined in: [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/connect-router.ts#L24)
 
 The options of [connectRouter](../functions/connectRouter.md).
 
@@ -12,12 +12,12 @@ The options of [connectRouter](../functions/connectRouter.md).
 
 ## Properties
 
-| Property                                               | Modifier   | Type                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Inherited from                                                                                                                                                                           | Defined in                                                                                                                                              |
-| ------------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                    | `readonly` | [`RoutableActor`](RoutableActor.md)                                                                                                                | The actor to keep in step with the browser URL. It must implement `Routable`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/connect-router.ts#L26) |
-| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                                                                                                                           | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](../../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", which is the behaviour of every release before this option existed.                                                 | [`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/v5.0.2/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/v5.0.2/packages/play-url/src/base-path.ts#L76)                         |
-| <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.                                                                                                                                      | [`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/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L119)       |
-| <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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`patternCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-patterncache)     | [play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L40)                         |
-| <a id="property-routemap"></a> `routeMap`              | `readonly` | [`RouteLookupContract`](RouteLookupContract.md)                                                                                                    | The route lookup that matches a URL pathname to a machine state ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/connect-router.ts#L40) |
-| <a id="property-router"></a> `router`                  | `readonly` | `Pick`\<[`VanillaRouter`](VanillaRouter.md), `"history"`\>                                                                                         | The vanilla router from [createRouter](../functions/createRouter.md). The type states the HISTORY alone, because that is what this function reads: the bridge takes `location` for the first synchronization, it writes each navigation with `push`, and it watches the browser with `subscribe`. It calls `destroy` never, and it releases the history never — the owner of the history does that. A whole [VanillaRouter](VanillaRouter.md) satisfies it, and a caller that holds one passes it as it always did. A caller that holds a history and no router passes `{ history }`.                                                                                                                                          | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/connect-router.ts#L38) |
+| Property                                               | Modifier   | Type                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Inherited from                                                                                                                                                                           | Defined in                                                                                                                                              |
+| ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                    | `readonly` | [`RoutableActor`](RoutableActor.md)                                                                                                                  | The actor to keep in step with the browser URL. It must implement `Routable`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/connect-router.ts#L26) |
+| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                                                                                                                             | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](../../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", which is the behaviour of every release before this option existed.                                                 | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePath`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepath)             | [play-url/src/base-path.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L63)                         |
+| <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:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L77)                         |
+| <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/v6.0.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/v6.0.0/packages/play-pattern/src/cache.ts#L41)                         |
+| <a id="property-routemap"></a> `routeMap`              | `readonly` | [`RouteLookupContract`](RouteLookupContract.md)                                                                                                      | The route lookup that matches a URL pathname to a machine state ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/connect-router.ts#L40) |
+| <a id="property-router"></a> `router`                  | `readonly` | `Pick`\<[`VanillaRouter`](VanillaRouter.md), `"history"`\>                                                                                           | The vanilla router from [createRouter](../functions/createRouter.md). The type states the HISTORY alone, because that is what this function reads: the bridge takes `location` for the first synchronization, it writes each navigation with `push`, and it watches the browser with `subscribe`. It calls `destroy` never, and it releases the history never — the owner of the history does that. A whole [VanillaRouter](VanillaRouter.md) satisfies it, and a caller that holds one passes it as it always did. A caller that holds a history and no router passes `{ history }`.                                                                                                                                          | -                                                                                                                                                                                        | [play-dom-router/src/connect-router.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/connect-router.ts#L38) |

package/api/@xmachines/play-dom-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/v5.0.2/packages/play-router/src/types.ts#L336)
+Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v5.0.2/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/v5.0.2/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/v5.0.2/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/v5.0.2/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/v5.0.2/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/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. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.0/packages/play-router/src/types.ts#L337) |

package/api/@xmachines/play-dom-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/v5.0.2/packages/play-router/src/types.ts#L392)
+Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/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) | [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) | [play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v6.0.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/v5.0.2/packages/play-router/src/types.ts#L394)
+Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L394)
 
 Sends a route navigation event to the actor.
 

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

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

package/api/@xmachines/play-dom-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/v5.0.2/packages/play-router/src/types.ts#L565)
+Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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) | [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. | -                                                                                                                                                                       | [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)   | [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) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v6.0.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/v6.0.0/packages/play-pattern/src/cache.ts#L41)                   |

package/api/@xmachines/play-dom-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/v5.0.2/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/v6.0.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/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"`                          | [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?"` | [play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v6.0.0/packages/play-router/src/base-route-map.ts#L60) |

package/api/@xmachines/play-dom-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/v5.0.2/packages/play-router/src/types.ts#L436)
+Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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: [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: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.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/v5.0.2/packages/play-router/src/types.ts#L469)
+Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

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

@@ -2,7 +2,7 @@
 
 # Interface: RouterConnection()
 
-Defined in: [play-router/src/provider-lifecycle.ts:292](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L292)
+Defined in: [play-router/src/provider-lifecycle.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L291)
 
 What `connectRouter` of an adapter returns.
 
@@ -21,7 +21,7 @@ stale.
 RouterConnection(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:294](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L294)
+Defined in: [play-router/src/provider-lifecycle.ts:293](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L293)
 
 Stops the synchronization. The same call as [RouterConnection.disconnect](#disconnect).
 
@@ -33,50 +33,31 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
 
 | Property                                              | Modifier   | Type                                         | Description                                                                       | Defined in                                                                                                                                                |
 | ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L315) |
-| <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event.        | [play-router/src/provider-lifecycle.ts:317](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L317) |
+| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L309) |
+| <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event.        | [play-router/src/provider-lifecycle.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L311) |
 
 ## Methods
 
-### \[dispose\]()
+### disconnect()
 
 ```ts
-dispose: void;
+disconnect(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L313)
+Defined in: [play-router/src/provider-lifecycle.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L307)
 
-Stops the synchronization when the scope of a `using` declaration ends.
+Stops the synchronization. It is idempotent.
 
-This value IS the release of `connectRouter`, and all eight router adapters return
-it, so it carries the protocol of `@xmachines/play` like every other release of the
-ecosystem:
+A scope can own the connection: the connection is its own release, so
+`asDisposable` of `@xmachines/core/utils` publishes it with no second argument.
 
 ```ts
 {
-	using connection = connectRouter({ actor, router, routeMap });
+	using connection = asDisposable(connectRouter({ actor, router, routeMap }));
 	// disconnect() runs at the end of the scope, and after an exception too
 }
 ```
 
-The release is [RouterConnection.disconnect](#disconnect), which is idempotent.
-
-#### Returns
-
-`void`
-
----
-
-### disconnect()
-
-```ts
-disconnect(): void;
-```
-
-Defined in: [play-router/src/provider-lifecycle.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L296)
-
-Stops the synchronization.
-
 #### Returns
 
 `void`
@@ -89,7 +70,7 @@ Stops the synchronization.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:319](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L319)
+Defined in: [play-router/src/provider-lifecycle.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/provider-lifecycle.ts#L313)
 
 Moves the mount of the live bridge, with no teardown.
 

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

@@ -2,58 +2,43 @@
 
 # Interface: VanillaRouter
 
-Defined in: [play-dom-router/src/create-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/create-router.ts#L24)
+Defined in: [play-dom-router/src/create-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/create-router.ts#L24)
 
 The router that [createRouter](../functions/createRouter.md) builds and returns.
 
 The router wraps a [BrowserHistory](BrowserHistory.md) and a `RouteTree`, and it does nothing more.
-It OWNS the history, and the history patches `window.history.pushState`, so a scope
-that drops the router without releasing it leaves the global patched. The dispose key
-lets a scope do that work:
+It OWNS the history, and the history patches `window.history.pushState`, so a caller
+that drops the router without `destroy()` leaves the global patched. A scope can do
+that work: publish the router with `asDisposable` of `@xmachines/core/utils`, and name
+`destroy` as the release:
 
 ```ts
-using router = createRouter({ routeTree, history });
+const plain = createRouter({ routeTree, history });
+using router = asDisposable(plain, () => plain.destroy());
 ```
 
-The release covers the HISTORY alone, exactly as `destroy()` always did.
+`destroy()` covers the HISTORY alone.
 `connectRouter` hands back its own `RouterConnection`, and a scope that ends releases
 no connection for the caller: release the connection first, then the router.
 
-A caller that keeps `destroy()` keeps it: the two release the same work, and the
-release is idempotent because [BrowserHistory.destroy](BrowserHistory.md#destroy) is.
+`destroy()` is idempotent, because [BrowserHistory.destroy](BrowserHistory.md#destroy) is.
 
 ## Properties
 
 | Property                                    | Modifier   | Type                                                           | Description                                     | Defined in                                                                                                                                            |
 | ------------------------------------------- | ---------- | -------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`     | `readonly` | [`BrowserHistory`](BrowserHistory.md)                          | The history instance                            | [play-dom-router/src/create-router.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/create-router.ts#L28) |
-| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/index/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/create-router.ts#L33) |
+| <a id="property-history"></a> `history`     | `readonly` | [`BrowserHistory`](BrowserHistory.md)                          | The history instance                            | [play-dom-router/src/create-router.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/create-router.ts#L28) |
+| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/index/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/create-router.ts#L33) |
 
 ## Methods
 
-### \[dispose\]()
-
-```ts
-dispose: void;
-```
-
-Defined in: [play-dom-router/src/create-router.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/create-router.ts#L41)
-
-Releases the history with [VanillaRouter.destroy](#destroy). It is idempotent.
-
-#### Returns
-
-`void`
-
----
-
 ### destroy()
 
 ```ts
 destroy(): void;
 ```
 
-Defined in: [play-dom-router/src/create-router.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-dom-router/src/create-router.ts#L38)
+Defined in: [play-dom-router/src/create-router.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-dom-router/src/create-router.ts#L38)
 
 Cleans up
 

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

@@ -4,7 +4,7 @@
 
 The route pattern language of the XMachines Play Architecture.
 
-[![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-pattern)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-pattern)
 
 One parse of the URLPattern pathname grammar, and the path that it builds back.
 
@@ -25,13 +25,17 @@ It holds no `URLPattern` API. A parse is string work and it needs no constructor
 
 That line is why the package exists. [`@xmachines/play-xstate`](../play-xstate/README.md) BUILDS a URL and matches none, so it reads the grammar and installs no matching machinery for it.
 
-## Install
+## Installation
 
 ```bash
-pnpm add @xmachines/play-pattern
+pnpm add @xmachines/play-pattern @xmachines/core
 ```
 
-Most applications install it through [`@xmachines/play-url`](../play-url/README.md), which re-exports the language whole. [`@xmachines/play-router`](../play-router/README.md) re-exports the part that a router needs: `parsePattern` and `createPatternCache`.
+**Peer dependencies.** Install them with the package:
+
+- [`@xmachines/core`](../core/README.md) — the base package. This package reads the cache of its `cache` subpath.
+
+Most applications install it through [`@xmachines/play-url`](../play-url/README.md), which re-exports the language whole. [`@xmachines/play-router`](../play-router/README.md) re-exports the part that a router needs: `parsePattern`, and the cache contract `KeyValueCache` with its default `createLruCache`. The cache belongs to [`@xmachines/core`](../core/README.md) on its `cache` subpath, and this package re-exports it.
 
 ## Usage
 
@@ -92,11 +96,11 @@ it matches none, so it reads the grammar and it installs no matching machinery f
 ## Interfaces
 
 - [GroupPart](interfaces/GroupPart.md)
+- [KeyValueCache](interfaces/KeyValueCache.md)
 - [LiteralPart](interfaces/LiteralPart.md)
 - [ParamPart](interfaces/ParamPart.md)
 - [ParsedPattern](interfaces/ParsedPattern.md)
 - [ParseOptions](interfaces/ParseOptions.md)
-- [PatternCache](interfaces/PatternCache.md)
 - [PatternParam](interfaces/PatternParam.md)
 
 ## Type Aliases
@@ -109,7 +113,7 @@ it matches none, so it reads the grammar and it installs no matching machinery f
 ## Functions
 
 - [buildPath](functions/buildPath.md)
-- [createPatternCache](functions/createPatternCache.md)
+- [createLruCache](functions/createLruCache.md)
 - [getIndexKey](functions/getIndexKey.md)
 - [isDotSegment](functions/isDotSegment.md)
 - [parsePattern](functions/parsePattern.md)

package/api/@xmachines/play-pattern/functions/buildPath.md

@@ -6,7 +6,7 @@
 function buildPath(pattern, params?, options?): PathBuildResult;
 ```
 
-Defined in: [pattern-grammar.ts:713](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L713)
+Defined in: [play-pattern/src/pattern-grammar.ts:713](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-pattern/src/pattern-grammar.ts#L713)
 
 Builds the path that a pattern describes, with each param filled from `params`.
 

package/api/@xmachines/play-pattern/functions/{createPatternCache.md → createLruCache.md}

@@ -1,25 +1,27 @@
-[API](../../../README.md) / [@xmachines/play-pattern](../README.md) / createPatternCache
+[API](../../../README.md) / [@xmachines/play-pattern](../README.md) / createLruCache
 
-# Function: createPatternCache()
+# Function: createLruCache()
 
 ```ts
-function createPatternCache<V>(maxSize?): PatternCache<V>;
+function createLruCache<V>(maxSize?): KeyValueCache<V>;
 ```
 
-Defined in: [cache.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L85)
+Defined in: [core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/cache.ts#L54)
 
 Builds a cache that forgets its least recently used entries.
 
 ## The algorithm
 
-Two maps, and no list. `recent` takes every write. When a write fills `recent`, it
-becomes `old` and a new `recent` opens, which drops the previous `old` whole. A read of
-a key of `old` moves the entry into `recent`, and THAT is what makes the eviction an
-LRU one rather than a FIFO one: an entry that every lookup reads moves forward, and an
-entry that nothing reads falls out with the map that holds it.
+Two maps, and no list. `recent` takes every write. When a write takes `recent` past
+`maxSize` entries, it becomes `old` and a new `recent` opens, which drops the previous
+`old` whole. A read of a key of `old` moves the entry into `recent`, and THAT is what
+makes the eviction an LRU one rather than a FIFO one: an entry that every lookup reads
+moves forward, and an entry that nothing reads falls out with the map that holds it.
 
-The cache therefore holds between `maxSize` and `2 * maxSize` entries, and it does no
-bookkeeping for a read that hits `recent`.
+The cache therefore holds `2 * maxSize + 1` entries at most: `old` holds `maxSize + 1`,
+and `recent` holds `maxSize`. It does no bookkeeping for a read that hits `recent`.
+
+A stored `undefined` reads as a miss. Store `null` for "no value".
 
 ## Type Parameters
 
@@ -35,13 +37,16 @@ bookkeeping for a read that hits `recent`.
 
 ## Returns
 
-[`PatternCache`](../interfaces/PatternCache.md)\<`V`\>
+[`KeyValueCache`](../interfaces/KeyValueCache.md)\<`V`\>
 
 A cache. It is not shared: each call builds one.
 
 ## Example
 
 ```typescript
-const cache = createPatternCache<ParsedPattern>(50);
-parsePattern("/profile/:userId", { patternCache: cache });
+import { createLruCache } from "@xmachines/core/cache";
+
+const cache = createLruCache<string>(50);
+cache.set("/profile/:userId", "profile");
+cache.get("/profile/:userId"); // "profile"
 ```

package/api/@xmachines/play-pattern/functions/getIndexKey.md

@@ -6,7 +6,7 @@
 function getIndexKey(path): string;
 ```
 
-Defined in: [pattern-grammar.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L201)
+Defined in: [play-pattern/src/pattern-grammar.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-pattern/src/pattern-grammar.ts#L201)
 
 Computes the key of the bucket index of a concrete PATH.
 

package/api/@xmachines/play-pattern/functions/isDotSegment.md

@@ -6,7 +6,7 @@
 function isDotSegment(segment): boolean;
 ```
 
-Defined in: [pattern-grammar.ts:872](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L872)
+Defined in: [play-pattern/src/pattern-grammar.ts:872](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-pattern/src/pattern-grammar.ts#L872)
 
 Answers whether one segment resolves away in a URL, rather than naming itself.