@xmachines/docs 5.0.2 → 6.1.0

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

@@ -2,7 +2,7 @@
 
 # Abstract Class: RouterBridgeBase
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L124)
+Defined in: [packages/play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L124)
 
 A `RouterBridge` whose machine is mounted at a URL prefix that can MOVE while the
 bridge stays connected.
@@ -53,7 +53,7 @@ new RouterBridgeBase(
 ): RouterBridgeBase;
 ```
 
-Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L249)
+Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L249)
 
 #### Parameters
 
@@ -79,7 +79,7 @@ Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.
 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.
@@ -104,7 +104,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.
@@ -155,7 +155,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.
 
@@ -189,7 +189,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.
 
@@ -212,7 +212,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-router/index/functions/buildPlayRouteEvent.md

@@ -9,7 +9,7 @@ function buildPlayRouteEvent(options): {
 } | null;
 ```
 
-Defined in: [packages/play-router/src/router-sync.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L161)
+Defined in: [packages/play-router/src/router-sync.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L162)
 
 Builds a normalized `play.route` event from the raw input of a router or of a
 browser.

package/api/@xmachines/play-router/index/functions/buildRouteTree.md

@@ -6,7 +6,7 @@
 function buildRouteTree<TGraph>(routes): RouteTree<TGraph>;
 ```
 
-Defined in: [packages/play-router/src/build-tree.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/build-tree.ts#L38)
+Defined in: [packages/play-router/src/build-tree.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/build-tree.ts#L38)
 
 Builds the hierarchical route tree from the flat list of the routes
 

package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md

@@ -6,7 +6,7 @@
 function cleanFrameworkParams(params): Record<string, string>;
 ```
 
-Defined in: [packages/play-url/src/framework-params.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L107)
+Defined in: [packages/play-url/src/framework-params.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L108)
 
 The params of a framework router, in the shape that [pickOwnParams](pickOwnParams.md) reads.
 

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

@@ -1,25 +1,27 @@
-[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / createPatternCache
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / createLruCache
 
-# Function: createPatternCache()
+# Function: createLruCache()
 
 ```ts
-function createPatternCache<V>(maxSize?): PatternCache<V>;
+function createLruCache<V>(maxSize?): KeyValueCache<V>;
 ```
 
-Defined in: [packages/play-pattern/src/cache.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L85)
+Defined in: [packages/core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.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-router/index/functions/createRouteMapFromTree.md

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

package/api/@xmachines/play-router/index/functions/createRouterConnection.md

@@ -6,7 +6,7 @@
 function createRouterConnection(bridge): RouterConnection;
 ```
 
-Defined in: [packages/play-router/src/provider-lifecycle.ts:330](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L330)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L324)
 
 Wraps a live bridge in the [RouterConnection](../interfaces/RouterConnection.md) that `connectRouter` returns.
 

package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md

@@ -6,7 +6,7 @@
 function detectDuplicateRoutes(routes): void;
 ```
 
-Defined in: [packages/play-router/src/validate-routes.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/validate-routes.ts#L70)
+Defined in: [packages/play-router/src/validate-routes.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/validate-routes.ts#L70)
 
 Finds each duplicate route path
 

package/api/@xmachines/play-router/index/functions/extractQuery.md

@@ -6,7 +6,7 @@
 function extractQuery(search): Record<string, string>;
 ```
 
-Defined in: [packages/play-router/src/router-sync.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L135)
+Defined in: [packages/play-router/src/router-sync.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L136)
 
 Parses a URL search string into the plain object that a `play.route` event
 needs.

package/api/@xmachines/play-router/index/functions/extractRouteParams.md

@@ -6,7 +6,7 @@
 function extractRouteParams(pathname, pattern, options?): Record<string, string>;
 ```
 
-Defined in: [packages/play-router/src/router-sync.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L84)
+Defined in: [packages/play-router/src/router-sync.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L85)
 
 Reads the named path parameters of a URL, with the URLPattern API.
 

package/api/@xmachines/play-router/index/functions/findRouteById.md

@@ -6,7 +6,7 @@
 function findRouteById(tree, id): RouteNode | undefined;
 ```
 
-Defined in: [packages/play-router/src/find-route.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/find-route.ts#L58)
+Defined in: [packages/play-router/src/find-route.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/find-route.ts#L58)
 
 Finds a route node by its state ID
 

package/api/@xmachines/play-router/index/functions/findRouteByPath.md

@@ -6,7 +6,7 @@
 function findRouteByPath(tree, path, options?): RouteNode | undefined;
 ```
 
-Defined in: [packages/play-router/src/find-route.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/find-route.ts#L96)
+Defined in: [packages/play-router/src/find-route.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/find-route.ts#L96)
 
 Finds a route node by its URL path
 
@@ -42,7 +42,7 @@ const node = findRouteByPath(tree, "/dashboard");
 
 // With a cache that one request owns and drops
 const node = findRouteByPath(tree, "/dashboard", {
-	patternCache: createPatternCache(),
-	compiledCache: createPatternCache(),
+	patternCache: createLruCache(),
+	compiledCache: createLruCache(),
 });
 ```

package/api/@xmachines/play-router/index/functions/isMountableBridge.md

@@ -6,7 +6,7 @@
 function isMountableBridge(bridge): bridge is MountableRouterBridge;
 ```
 
-Defined in: [packages/play-router/src/provider-lifecycle.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L137)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L136)
 
 Tells you whether a bridge can move its mount.
 

package/api/@xmachines/play-router/index/functions/joinBasePath.md

@@ -6,7 +6,7 @@
 function joinBasePath(basePath, path): string;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L307)
+Defined in: [packages/play-url/src/base-path.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L307)
 
 Adds the base path to an outbound path of the machine.
 

package/api/@xmachines/play-router/index/functions/mountKey.md

@@ -6,7 +6,7 @@
 function mountKey(basePath?, basePathParams?): string;
 ```
 
-Defined in: [packages/play-router/src/provider-lifecycle.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L155)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L154)
 
 A key that changes when the MOUNT changes, and never when its identity changes.
 

package/api/@xmachines/play-router/index/functions/normalizeBasePath.md

@@ -6,7 +6,7 @@
 function normalizeBasePath(basePath?): string;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L134)
+Defined in: [packages/play-url/src/base-path.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L134)
 
 Normalizes a base path, and it substitutes no `:param` segment of that path.
 

package/api/@xmachines/play-router/index/functions/openProviderBridge.md

@@ -6,7 +6,7 @@
 function openProviderBridge<TRouter, TActor>(BridgeCtor, __namedParameters): object;
 ```
 
-Defined in: [packages/play-router/src/provider-lifecycle.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L201)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:200](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L200)
 
 Builds a bridge, connects it, and hands back the way to close it.
 
@@ -37,5 +37,5 @@ The bridge, and a `close` that disconnects it one time.
 
 | Name      | Type                                            | Defined in                                                                                                                                                         |
 | --------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `bridge`  | [`RouterBridge`](../interfaces/RouterBridge.md) | [packages/play-router/src/provider-lifecycle.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L204) |
-| `close()` | () => `void`                                    | [packages/play-router/src/provider-lifecycle.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L204) |
+| `bridge`  | [`RouterBridge`](../interfaces/RouterBridge.md) | [packages/play-router/src/provider-lifecycle.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L203) |
+| `close()` | () => `void`                                    | [packages/play-router/src/provider-lifecycle.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L203) |

package/api/@xmachines/play-router/index/functions/parsePattern.md

@@ -6,7 +6,7 @@
 function parsePattern(pattern, options?): ParsedPattern;
 ```
 
-Defined in: [packages/play-pattern/src/pattern-grammar.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/pattern-grammar.ts#L264)
+Defined in: [packages/play-pattern/src/pattern-grammar.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/pattern-grammar.ts#L264)
 
 Reads a route pattern, one time for each distinct pattern.
 

package/api/@xmachines/play-router/index/functions/pickOwnParams.md

@@ -6,7 +6,7 @@
 function pickOwnParams(params, names, requiredNames?): Record<string, string> | null;
 ```
 
-Defined in: [packages/play-url/src/framework-params.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L43)
+Defined in: [packages/play-url/src/framework-params.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L44)
 
 Keeps the entries of `params` whose name the pattern of the machine declares, and
 only when the result covers EVERY name of that pattern.

package/api/@xmachines/play-router/index/functions/repointProviderBridge.md

@@ -6,7 +6,7 @@
 function repointProviderBridge(bridge, basePath?, basePathParams?): void;
 ```
 
-Defined in: [packages/play-router/src/provider-lifecycle.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L270)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L269)
 
 Moves the mount of a live bridge, and rebuilds nothing.
 

package/api/@xmachines/play-router/index/functions/resolveBasePath.md

@@ -6,7 +6,7 @@
 function resolveBasePath(basePath?, params?): ResolvedBasePath;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L184)
+Defined in: [packages/play-url/src/base-path.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L184)
 
 Resolves a base path and its params to the concrete prefix that a browser URL
 carries.

package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md

@@ -6,7 +6,7 @@
 function resolveFrameworkParams(source): Record<string, string>;
 ```
 
-Defined in: [packages/play-url/src/framework-params.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L220)
+Defined in: [packages/play-url/src/framework-params.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L221)
 
 Decides which params describe the route of the machine.
 

package/api/@xmachines/play-router/index/functions/sanitizePathname.md

@@ -6,7 +6,7 @@
 function sanitizePathname(pathname): string | null;
 ```
 
-Defined in: [packages/play-url/src/location.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L89)
+Defined in: [packages/play-url/src/location.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/location.ts#L89)
 
 Reads the pathname of a location, and refuses a location that no route can match.
 

package/api/@xmachines/play-router/index/functions/splitLocation.md

@@ -6,7 +6,7 @@
 function splitLocation(location): SplitLocation;
 ```
 
-Defined in: [packages/play-url/src/location.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/location.ts#L55)
+Defined in: [packages/play-url/src/location.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/location.ts#L55)
 
 Splits a location into its pathname, its query and its fragment.
 

package/api/@xmachines/play-router/index/functions/stripBasePath.md

@@ -6,7 +6,7 @@
 function stripBasePath(pathname, basePath): string | null;
 ```
 
-Defined in: [packages/play-url/src/base-path.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L280)
+Defined in: [packages/play-url/src/base-path.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L280)
 
 Removes the base path from an inbound location of the router.
 

package/api/@xmachines/play-router/index/functions/validateRouteFormat.md

@@ -6,7 +6,7 @@
 function validateRouteFormat(routePath, stateId): void;
 ```
 
-Defined in: [packages/play-router/src/validate-routes.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/validate-routes.ts#L27)
+Defined in: [packages/play-router/src/validate-routes.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/validate-routes.ts#L27)
 
 Checks the format of a route path
 

package/api/@xmachines/play-router/index/functions/validateStateExists.md

@@ -6,7 +6,7 @@
 function validateStateExists(stateId, stateIds): void;
 ```
 
-Defined in: [packages/play-router/src/validate-routes.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/validate-routes.ts#L43)
+Defined in: [packages/play-router/src/validate-routes.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/validate-routes.ts#L43)
 
 Checks that the set of the state IDs holds a state
 

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

@@ -2,7 +2,7 @@
 
 # Interface: BasePathOptions
 
-Defined in: [packages/play-url/src/base-path.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/base-path.ts#L48)
+Defined in: [packages/play-url/src/base-path.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L49)
 
 The base-path options that every router bridge, `connectRouter` function, and
 `PlayRouterProvider` component accepts.
@@ -28,5 +28,5 @@ connectRouter({
 
 | Property                                               | Modifier   | Type                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Defined in                                                                                                                               |
 | ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](#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.                                                 | [packages/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](#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. | [packages/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-basepath"></a> `basePath?`             | `readonly` | `string`                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix".                                                                                                                     | [packages/play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L62) |
+| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](#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. | [packages/play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L76) |

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

@@ -2,12 +2,12 @@
 
 # Interface: BuildPlayRouteEventOptions
 
-Defined in: [packages/play-router/src/router-sync.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L15)
+Defined in: [packages/play-router/src/router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L16)
 
 ## Properties
 
 | Property                                  | Type                                                   | Defined in                                                                                                                                         |
 | ----------------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [packages/play-router/src/router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L18) |
-| <a id="property-pathname"></a> `pathname` | `string`                                               | [packages/play-router/src/router-sync.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L16) |
-| <a id="property-search"></a> `search?`    | `string`                                               | [packages/play-router/src/router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-sync.ts#L17) |
+| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [packages/play-router/src/router-sync.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L19) |
+| <a id="property-pathname"></a> `pathname` | `string`                                               | [packages/play-router/src/router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L17) |
+| <a id="property-search"></a> `search?`    | `string`                                               | [packages/play-router/src/router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L18) |

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

@@ -2,7 +2,7 @@
 
 # Interface: CompileOptions
 
-Defined in: [packages/play-url/src/url-pattern-utils.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L106)
+Defined in: [packages/play-url/src/url-pattern-utils.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L106)
 
 What [getCompiledPattern](../../../play-url/index/functions/getCompiledPattern.md) reads: [ParseOptions](ParseOptions.md) with the compiled cache.
 
@@ -29,7 +29,7 @@ A caller holds ONE object and hands it to every call of the routing layer, becau
 
 ## Properties
 
-| Property                                             | Modifier   | Type                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Inherited from                                                                            | Defined in                                                                                                                                                 |
-| ---------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](PatternCache.md)\<[`URLPatternLike`](../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. | -                                                                                         | [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-patterncache"></a> `patternCache?`   | `readonly` | [`PatternCache`](PatternCache.md)\<[`ParsedPattern`](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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [`ParseOptions`](ParseOptions.md).[`patternCache`](ParseOptions.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`](KeyValueCache.md)\<[`URLPatternLike`](../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. | -                                                                                         | [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-patterncache"></a> `patternCache?`   | `readonly` | [`KeyValueCache`](KeyValueCache.md)\<[`ParsedPattern`](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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [`ParseOptions`](ParseOptions.md).[`patternCache`](ParseOptions.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-router/index/interfaces/FrameworkParamsSource.md

@@ -2,7 +2,7 @@
 
 # Interface: FrameworkParamsSource
 
-Defined in: [packages/play-url/src/framework-params.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L171)
+Defined in: [packages/play-url/src/framework-params.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L172)
 
 What [resolveFrameworkParams](../functions/resolveFrameworkParams.md) needs from the bridge that calls it.
 
@@ -12,12 +12,12 @@ What [resolveFrameworkParams](../functions/resolveFrameworkParams.md) needs from
 
 ## Properties
 
-| Property                                           | Modifier   | Type                                                                     | Description                                                                                                                                                                                                                             | Inherited from                                                                            | Defined in                                                                                                                                               |
-| -------------------------------------------------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath`          | `public`   | `string`                                                                 | The resolved prefix of the mount. `""` means that the machine owns the router.                                                                                                                                                          | -                                                                                         | [packages/play-url/src/framework-params.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L175) |
-| <a id="property-pathname"></a> `pathname?`         | `public`   | `string`                                                                 | The machine-side path of the location, with the mount prefix already removed. The field is OPTIONAL, so a caller that was written before it keeps its behaviour: the one branch that reads it falls back without it, exactly as it did. | -                                                                                         | [packages/play-url/src/framework-params.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L182) |
-| <a id="property-pattern"></a> `pattern`            | `public`   | `string` \| `null` \| `undefined`                                        | The route pattern of the match, from `routeMap.getPathByStateId`.                                                                                                                                                                       | -                                                                                         | [packages/play-url/src/framework-params.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L173) |
-| <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](PatternCache.md)\<[`ParsedPattern`](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.                                                                                                                | [`ParseOptions`](ParseOptions.md).[`patternCache`](ParseOptions.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-basepath"></a> `basePath`          | `public`   | `string`                                                                   | The resolved prefix of the mount. `""` means that the machine owns the router.                                                                                                                                                          | -                                                                                         | [packages/play-url/src/framework-params.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L176) |
+| <a id="property-pathname"></a> `pathname?`         | `public`   | `string`                                                                   | The machine-side path of the location, with the mount prefix already removed. The field is OPTIONAL, so a caller that was written before it keeps its behaviour: the one branch that reads it falls back without it, exactly as it did. | -                                                                                         | [packages/play-url/src/framework-params.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L183) |
+| <a id="property-pattern"></a> `pattern`            | `public`   | `string` \| `null` \| `undefined`                                          | The route pattern of the match, from `routeMap.getPathByStateId`.                                                                                                                                                                       | -                                                                                         | [packages/play-url/src/framework-params.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L174) |
+| <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](KeyValueCache.md)\<[`ParsedPattern`](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.                                                                                                                | [`ParseOptions`](ParseOptions.md).[`patternCache`](ParseOptions.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)                 |
 
 ## Methods
 
@@ -27,7 +27,7 @@ What [resolveFrameworkParams](../functions/resolveFrameworkParams.md) needs from
 fallback(): Record<string, string>;
 ```
 
-Defined in: [packages/play-url/src/framework-params.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L186)
+Defined in: [packages/play-url/src/framework-params.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L187)
 
 The URLPattern extraction of the base class, read lazily.
 
@@ -43,7 +43,7 @@ The URLPattern extraction of the base class, read lazily.
 frameworkParams(): Record<string, string>;
 ```
 
-Defined in: [packages/play-url/src/framework-params.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/framework-params.ts#L184)
+Defined in: [packages/play-url/src/framework-params.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L185)
 
 The params of the framework router, read lazily and cleaned of empty values.