@xmachines/docs 4.0.0 → 5.0.0

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

@@ -2,7 +2,7 @@
 
 # Interface: RoutableActor
 
-Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L392)
+Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L392)
 
 The minimal actor interface that `RouterBridgeBase` and every framework router
 adapter require.
@@ -44,10 +44,10 @@ class MyBridge extends RouterBridgeBase {
 
 ## Properties
 
-| Property                                          | Modifier   | Type                                                                                         | Inherited from                                                                                                                                      | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.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/v4.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/v4.0.0/packages/play-router/src/types.ts#L355) |
+| 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.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/v5.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/v4.0.0/packages/play-router/src/types.ts#L394)
+Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L394)
 
 Sends a route navigation event to the actor.
 

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

@@ -2,12 +2,18 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [play-router/src/types.ts:567](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L567)
+Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L565)
 
 The options of `createRouteMap` and of `createRouteMapFromTree`.
 
+## Extends
+
+- [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md)
+
 ## Properties
 
-| Property                                     | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Defined in                                                                                                                      |
-| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cachesize"></a> `cacheSize?` | `number` | The maximum number of the resolved parameterized path lookups in the cache. `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example `/profile/:userId`, with URLPattern on each call. The map keeps each path of a frequent visit in an LRU cache, and a later lookup of that path is therefore O(1). Raise this value for an application with a large set of parameterized routes, or with a high frequency of the navigation. The default is `500`. | [play-router/src/types.ts:579](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L579) |
+| 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.0/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.0/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.0/packages/play-pattern/src/cache.ts#L40)                   |

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

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L54)
+Defined in: [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.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:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L58) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/base-route-map.ts#L56) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.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/v5.0.0/packages/play-router/src/base-route-map.ts#L60) |

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

@@ -2,18 +2,18 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:438](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L438)
+Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
 The interface defines the connection of the lifecycle between the infrastructure,
 for example a framework router, and the Actor. The infrastructure builds a "bridge"
-to the Actor: it observes the signals of the Actor, and it manages its own
+to the Actor: it observes the atoms of the Actor, and it manages its own
 lifecycle accordingly.
 
 **Architectural context:** the interface implements **Passive Infrastructure
 (INV-04)**, because it gives an observation in one direction. The infrastructure
-connects to observe the signals of the Actor (currentRoute, currentView, and
+connects to observe the atoms of the Actor (currentRoute, currentView, and
 state), and it reflects each change. It makes no decision about the state.
 
 ## Example
@@ -22,24 +22,22 @@ The implementation of a framework router bridge
 
 ```typescript
 import type { RouterBridge } from "@xmachines/play-router";
-import { Signal } from "@xmachines/play-signals";
+import { watchAtom, type Cleanup } from "@xmachines/play-atom";
 
 class MyRouterBridge implements RouterBridge {
-	private watcher: Signal.Watcher | null = null;
+	private stop: Cleanup | null = null;
 
 	async connect(): Promise<void> {
-		// Start the observation of the actor.currentRoute signal
-		this.watcher = new Signal.subtle.Watcher(() => {
-			const route = actor.currentRoute.get();
+		// Start the observation of the actor.currentRoute atom
+		this.stop = watchAtom(actor.currentRoute, (route) => {
 			if (route) router.navigate(route);
 		});
-		this.watcher.watch(actor.currentRoute);
 	}
 
 	async disconnect(): Promise<void> {
-		// Stop the observation, and clean the watchers up
-		this.watcher?.unwatch(actor.currentRoute);
-		this.watcher = null;
+		// Stop the observation, and release the subscription
+		this.stop?.();
+		this.stop = null;
 	}
 }
 ```
@@ -56,12 +54,12 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:455](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L455)
+Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L453)
 
 Connects the router bridge to the Actor
 
 The infrastructure calls it when it must start the observation of the Actor
-signals, and when it must bring its own state, for example the browser URL, in line
+atoms, and when it must bring its own state, for example the browser URL, in line
 with the Actor state.
 
 #### Returns
@@ -75,7 +73,7 @@ The promise that resolves after the connection, or void for a synchronous connec
 ```typescript
 const bridge: RouterBridge = createBridge(actor, router);
 await bridge.connect();
-// The bridge observes the actor.currentRoute signal now
+// The bridge observes the actor.currentRoute atom now
 ```
 
 ---
@@ -86,12 +84,12 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:471](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L471)
+Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 
 The infrastructure calls it when it must stop the observation and free its
-resources, for example a signal watcher and an event listener.
+resources, for example an atom watcher and an event listener.
 
 #### Returns
 

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

@@ -11,7 +11,7 @@ type PlayRouterBridgeConstructor<TRouter, TActor> = (
 ) => RouterBridge;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L107)
+Defined in: [play-router/src/provider-lifecycle.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L119)
 
 The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
 
@@ -19,6 +19,13 @@ The constructor shape that a bridge class must satisfy for a provider factory: `
 type of that actor reaches the bridge whole. A bridge that reads no spec binds nothing
 and receives the default.
 
+The options are [RouterBridgeOptions](../../play-router/index/interfaces/RouterBridgeOptions.md), because that is what
+[openProviderBridge](../../play-router/index/functions/openProviderBridge.md) hands to the constructor: the base path AND the caches of a
+parse and a compilation. A `BasePathOptions` here named half of the value that travels,
+so a bridge author read the type and learned of no cache. A bridge that declares the
+narrower `BasePathOptions` still satisfies this type, and it reads the fields that it
+knows.
+
 The return type is `RouterBridge`, the published contract of a bridge, so a
 consumer bridge of its own keeps compiling. Every bridge on `RouterBridgeBase` also
 satisfies `MountableRouterBridge`, and the provider finds that mount API at run
@@ -34,12 +41,12 @@ existed.
 
 ## Parameters
 
-| Parameter  | Type                                                                     |
-| ---------- | ------------------------------------------------------------------------ |
-| `router`   | `TRouter`                                                                |
-| `actor`    | `TActor`                                                                 |
-| `routeMap` | [`RouteMap`](../classes/RouteMap.md)                                     |
-| `options?` | [`BasePathOptions`](../../play-dom-router/interfaces/BasePathOptions.md) |
+| Parameter  | Type                                                                               |
+| ---------- | ---------------------------------------------------------------------------------- |
+| `router`   | `TRouter`                                                                          |
+| `actor`    | `TActor`                                                                           |
+| `routeMap` | [`RouteMap`](../classes/RouteMap.md)                                               |
+| `options?` | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md) |
 
 ## Returns
 

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

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

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

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

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

@@ -4,7 +4,7 @@
 
 Route tree extraction from XState v5 state machines. Part of [@xmachines/play](../play/README.md) Universal Player Architecture.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-4.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-router)
+[![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.0-blue)](https://www.npmjs.com/package/@xmachines/play-router)
 
 This package extracts the routes from a machine graph and looks them up in both directions. The Actor therefore keeps the authority over the navigation.
 
@@ -16,15 +16,26 @@ This package extracts the routes from a machine graph and looks them up in both
 ## Installation
 
 ```bash
-pnpm add xstate@^5.33.0
-pnpm add @xmachines/play-router
+pnpm add @xmachines/play-router @xmachines/play @xmachines/play-atom
 ```
 
-**Peer dependencies:**
+**Peer dependencies.** Install them with the package:
 
-- `xstate` ^5.33.0 — XState v5 state machine runtime (an OPTIONAL peer: the `@xmachines/play-router/xstate` subpath alone reads it)
+- [`@xmachines/play`](../play/README.md) — the core protocol. This package reads `asCleanup` and `DISPOSE` from it, and the error classes from its `errors` subpath.
+- [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives. The bridge reads the route of the actor with `watchAtom`.
 
-**URLPattern:** this package matches each route with the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern). It uses the native API when the runtime has one, and it falls back to `urlpattern-polyfill`, which it carries as an ordinary dependency. **You install nothing and you load nothing.**
+**Optional peers.** The `@xmachines/play-router/xstate` subpath alone reads them. Install them when you read that subpath, and not before:
+
+```bash
+pnpm add xstate@^5.33.0 @statelyai/graph@^2.4.0
+```
+
+- `xstate` ^5.33.0 — the XState v5 runtime.
+- `@statelyai/graph` ^2.4.0 — the graph of the machine that `extractMachineRoutes` walks.
+
+A consumer of the root barrel installs neither one. `@statelyai/graph` was an ordinary dependency until this release, so every consumer of the root carried it; it now follows the same rule as `xstate`, which the same files read.
+
+**URLPattern:** this package matches each route with the [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern). It uses the native API when the runtime has one, and it falls back to `urlpattern-polyfill`, which [`@xmachines/play-url`](../play-url/README.md) carries as an ordinary dependency. **You install nothing and you load nothing.**
 
 The [routing guide](../../../guides/routing.md) states the pattern language: the forms, the modifiers, the prefix rule, and the one divergence from the standard.
 
@@ -300,7 +311,7 @@ Each `stateId` comes from the route tree, so it carries NO `#`. A host that keys
 route table on the target of a `play.route` event adds the `#` itself, because the
 event always carries the prefixed form.
 
-> Under a mount, `@xmachines/play-vue-router` and `@xmachines/play-solid-router` read
+> Under a mount, [`@xmachines/play-vue-router`](../play-vue-router/README.md) and [`@xmachines/play-solid-router`](../play-solid-router/README.md) read
 > the pre-parsed route params of their framework never: under a prefix the framework
 > matched a route of the HOST by construction, because the machine owns the suffix of
 > the path only. Those params therefore describe the route of the machine never, even
@@ -401,9 +412,9 @@ The MAIN entry point reads no state machine. The machine half is
 ### The machine half — subpath `@xmachines/play-router/xstate`
 
 A route of XMachines is a fact about a STATE. This entry point reads that fact out of an
-XState v5 machine. The main entry point reads it never, so `xstate` is an OPTIONAL peer
-dependency of this package, and a bundler drops `@statelyai/graph` for a consumer that
-imports this entry point nowhere.
+XState v5 machine. The main entry point reads it never, so `xstate` and `@statelyai/graph`
+are OPTIONAL peer dependencies of this package: a consumer that imports this entry point
+nowhere installs neither one.
 
 ```typescript
 import { createRouteMap, extractMachineRoutes } from "@xmachines/play-router/xstate";
@@ -458,8 +469,8 @@ it safe is the same in both, so it lives here.
 | Export                                         | Description                                                                                                                                                                                                                    |
 | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `resolveFrameworkParams(source)`               | Decides which params describe the route of the machine: `{}`, the parse of the framework, or the fallback                                                                                                                      |
-| `getPatternParamNames(pattern)`                | The names of every `:param` of a route pattern. A `*` wildcard carries none                                                                                                                                                    |
-| `getRequiredPatternParamNames(pattern)`        | The names the pattern REQUIRES, so an optional `:name?` is left out                                                                                                                                                            |
+| `parsePattern(pattern).names`                  | The names of every `:param` of a route pattern. An anonymous param carries none                                                                                                                                                |
+| `parsePattern(pattern).requiredNames`          | The names the pattern REQUIRES, so an optional `:name?` is left out                                                                                                                                                            |
 | `pickOwnParams(params, names, requiredNames?)` | The params that the pattern declares, or `null` when the framework covers them not. `requiredNames` says which names may NOT be absent; it defaults to every name, so a two-argument call treats an optional `:name?` as a gap |
 | `cleanFrameworkParams(params)`                 | The params of a framework with no absent value, each one a string                                                                                                                                                              |
 
@@ -581,7 +592,7 @@ breadcrumb. It also carries three fields that the routing layer reads:
 | `reenter` | `false`  | Whether the transition re-enters its own domain. See the note below.            |
 | `data`    | none     | The extra data of the route: a literal value, or a function of the event        |
 
-`@xmachines/play-xstate` reads `handler`, `reenter`, and `data` when it generates the
+[`@xmachines/play-xstate`](../play-xstate/README.md) reads `handler`, `reenter`, and `data` when it generates the
 transitions. See the README of that package for what each value does.
 
 **The four names are RESERVED, and this is a change of behaviour.** An earlier release
@@ -621,7 +632,7 @@ Always use `node.fullPath` to match a browser URL and to build a route map. Neve
 - **[@xmachines/play](../play/README.md)** — Core protocol types (`PlayEvent`, `PlayError`)
 - **[@xmachines/play-actor](../play-actor/README.md)** — the actor contract (`PlayActor`). An actor that adds `Routable` of this package satisfies `RoutableActor` structurally
 - **[@xmachines/play-url](../play-url/README.md)** — the URL language. This package re-exports its base path and its framework params, for an adapter on `RouterBridgeBase`
-- **[@xmachines/play-signals](../play-signals/README.md)** — the TC39 Signals polyfill that observes the actor route
+- **[@xmachines/play-atom](../play-atom/README.md)** — the atom primitives that observe the actor route
 - **[@xmachines/play-xstate](../play-xstate/README.md)** — the XState v5 logic adapter, which works with a route tree
 - **[@xmachines/play-tanstack-router](../play-tanstack-router/README.md)** — Shared TanStack Router bridge base (framework-agnostic)
 - **[@xmachines/play-tanstack-react-router](../play-tanstack-react-router/README.md)** — TanStack Router adapter (React)

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

@@ -2,7 +2,7 @@
 
 # Class: DuplicateBridgeError
 
-Defined in: [packages/play-router/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L75)
+Defined in: [packages/play-router/src/errors.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L75)
 
 `RouterBridgeBase.connect()` throws this error when a second bridge connects to an
 actor with an active bridge connection.
@@ -44,7 +44,7 @@ try {
 new DuplicateBridgeError(): DuplicateBridgeError;
 ```
 
-Defined in: [packages/play-router/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L76)
+Defined in: [packages/play-router/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L76)
 
 #### Returns
 
@@ -59,10 +59,10 @@ Defined in: [packages/play-router/src/errors.ts:76](https://gitlab.com/xmachin-e
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L76) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L76) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L66) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                          |
 

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

@@ -2,7 +2,7 @@
 
 # Class: DuplicateRoutePathError
 
-Defined in: [packages/play-router/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L135)
+Defined in: [packages/play-router/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L135)
 
 `detectDuplicateRoutes()` throws this error when two states or more hold the same
 URL path.
@@ -21,7 +21,7 @@ URL path.
 new DuplicateRoutePathError(duplicates): DuplicateRoutePathError;
 ```
 
-Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L139)
+Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L139)
 
 #### Parameters
 
@@ -42,11 +42,11 @@ Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-
 | Property                                                | Modifier   | Type       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                                 |
 | ------------------------------------------------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`   | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L76)                 |
-| <a id="property-duplicates"></a> `duplicates`           | `readonly` | `string`[] | The list of the path → state-ID mappings of the conflict, for a person to read.                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-router/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L137) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`   | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L76)                 |
+| <a id="property-duplicates"></a> `duplicates`           | `readonly` | `string`[] | The list of the path → state-ID mappings of the conflict, for a person to read.                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-router/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L137) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`   | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L66)                 |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`   | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L66)                 |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`   | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                          |
 

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

@@ -2,7 +2,7 @@
 
 # Class: EmptyRoutePathError
 
-Defined in: [packages/play-router/src/errors.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L93)
+Defined in: [packages/play-router/src/errors.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L93)
 
 `validateRouteFormat()` throws this error when a state declares a `meta.route`
 field with an empty string as its path.
@@ -21,7 +21,7 @@ field with an empty string as its path.
 new EmptyRoutePathError(stateId): EmptyRoutePathError;
 ```
 
-Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L97)
+Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L97)
 
 #### Parameters
 
@@ -42,12 +42,12 @@ Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-e
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                               |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                        |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L76)               |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L76)               |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                        |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                        |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L66)               |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L66)               |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                        |
-| <a id="property-stateid"></a> `stateId`                 | `readonly` | `string`  | The state ID with the empty route path.                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                | [packages/play-router/src/errors.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/errors.ts#L95) |
+| <a id="property-stateid"></a> `stateId`                 | `readonly` | `string`  | The state ID with the empty route path.                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                | [packages/play-router/src/errors.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/errors.ts#L95) |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                        |
 
 ## Methods

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

@@ -2,7 +2,7 @@
 
 # Class: InvalidBasePathError
 
-Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/errors.ts#L99)
+Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L99)
 
 Thrown when a `basePath` option resolves to one concrete URL prefix never.
 
@@ -45,7 +45,7 @@ try {
 new InvalidBasePathError(basePath, reason): InvalidBasePathError;
 ```
 
-Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/errors.ts#L103)
+Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L103)
 
 #### Parameters
 
@@ -66,12 +66,12 @@ Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/
 
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                           |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-basepath"></a> `basePath`               | `readonly` | `string`  | The `basePath` option of the refusal, exactly as the caller gave it.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/errors.ts#L101) |
+| <a id="property-basepath"></a> `basePath`               | `readonly` | `string`  | The `basePath` option of the refusal, exactly as the caller gave it.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L101) |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                    |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L76)           |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L76)           |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                    |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                    |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/errors.ts#L66)           |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L66)           |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                    |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                    |