@xmachines/docs 3.0.0 → 5.0.0

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

@@ -0,0 +1,26 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / Routable
+
+# Interface: Routable
+
+Defined in: [packages/play-router/src/types.ts:353](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L353)
+
+An optional capability: the routing support
+
+## Extended by
+
+- [`RoutableActor`](RoutableActor.md)
+- [`RoutableActor`](../../../play-dom-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-react-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-solid-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-sveltekit-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-svelte-spa-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-tanstack-react-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-tanstack-solid-router/interfaces/RoutableActor.md)
+- [`RoutableActor`](../../../play-vue-router/index/interfaces/RoutableActor.md)
+
+## Properties
+
+| Property                                          | Modifier   | Type                                                                                  | Defined in                                                                                                                               |
+| ------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [packages/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`                                                                    | [packages/play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L355) |

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

@@ -0,0 +1,72 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RoutableActor
+
+# Interface: RoutableActor
+
+Defined in: [packages/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.
+
+It names `send` itself, and it therefore gives `RouterBridgeBase.actor.send` a type that
+accepts a `PlayRouteEvent` directly. That removes the unsafe cast
+`(actor.send as (e: PlayRouteEvent) => void)`.
+
+It is [Routable](Routable.md) with `send`. The two members of the capability are declared once,
+in `Routable`, and this interface extends it. A copy of them here drifts the day that
+one of the two files changes.
+
+**It names the view NOWHERE. Routing implies no rendering.** No file of this package,
+and no file of any of the eight router adapters, ever reads `currentView`. A provider
+whose renderer callback reads the view binds its own `TActor`, and a constraint keeps
+the concrete type of the actor whole, so that callback still reads the exact spec of
+that actor.
+
+Every `PlayActor` of `@xmachines/play-actor` that also implements `Routable`, and whose
+event union holds `PlayRouteEvent`, satisfies this interface structurally. A machine
+that declares no route event does NOT satisfy it, and that refusal is correct: a bridge
+cannot navigate an actor that receives no route event.
+
+## Example
+
+```typescript
+import type { RoutableActor } from "@xmachines/play-router";
+
+class MyBridge extends RouterBridgeBase {
+	constructor(actor: RoutableActor, routeMap: RouteMap) {
+		super(actor, routeMap);
+	}
+}
+```
+
+## Extends
+
+- [`Routable`](Routable.md)
+
+## Properties
+
+| Property                                          | Modifier   | Type                                                                                  | Inherited from                                                                | Defined in                                                                                                                               |
+| ------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](Routable.md).[`currentRoute`](Routable.md#property-currentroute) | [packages/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`](Routable.md).[`initialRoute`](Routable.md#property-initialroute) | [packages/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
+
+### send()
+
+```ts
+send(event): void;
+```
+
+Defined in: [packages/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.
+
+#### Parameters
+
+| Parameter | Type                                  |
+| --------- | ------------------------------------- |
+| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
+
+#### Returns
+
+`void`

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouteInfo.md

@@ -1,19 +1,19 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteInfo
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteInfo
 
 # Interface: RouteInfo
 
-Defined in: [play-router/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L61)
+Defined in: [packages/play-router/src/types.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L156)
 
 The route information of a state node
 
 ## Properties
 
-| Property                                      | Type                                                | Description                                                                                                                                                 | Defined in                                                                                                                    |
-| --------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-isabsolute"></a> `isAbsolute` | `boolean`                                           | It tells you if the route path is absolute, which means that it starts with /                                                                               | [play-router/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L71) |
-| <a id="property-metadata"></a> `metadata`     | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | The original route metadata                                                                                                                                 | [play-router/src/types.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L78) |
-| <a id="property-pattern"></a> `pattern?`      | `string`                                            | The route pattern with its parameters, for example /profile/:userId, when routePath holds a parameter                                                       | [play-router/src/types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L69) |
-| <a id="property-routable"></a> `routable`     | `boolean`                                           | It tells you if this state has a route, which means that it has a meta.route field. true = it has a meta.route field, and it can receive a play.route event | [play-router/src/types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L76) |
-| <a id="property-routepath"></a> `routePath`   | `string`                                            | The route path of meta.route                                                                                                                                | [play-router/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L67) |
-| <a id="property-stateid"></a> `stateId`       | `string`                                            | The identifier of the state: node.id, or path.join('.')                                                                                                     | [play-router/src/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L63) |
-| <a id="property-statepath"></a> `statePath`   | `string`[]                                          | The segments of the state path, from the root                                                                                                               | [play-router/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L65) |
+| Property                                      | Type                                                | Description                                                                                                                                                 | Defined in                                                                                                                               |
+| --------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-isabsolute"></a> `isAbsolute` | `boolean`                                           | It tells you if the route path is absolute, which means that it starts with /                                                                               | [packages/play-router/src/types.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L166) |
+| <a id="property-metadata"></a> `metadata`     | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | The original route metadata                                                                                                                                 | [packages/play-router/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L173) |
+| <a id="property-pattern"></a> `pattern?`      | `string`                                            | The route pattern with its parameters, for example /profile/:userId, when routePath holds a parameter                                                       | [packages/play-router/src/types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L164) |
+| <a id="property-routable"></a> `routable`     | `boolean`                                           | It tells you if this state has a route, which means that it has a meta.route field. true = it has a meta.route field, and it can receive a play.route event | [packages/play-router/src/types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L171) |
+| <a id="property-routepath"></a> `routePath`   | `string`                                            | The route path of meta.route                                                                                                                                | [packages/play-router/src/types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L162) |
+| <a id="property-stateid"></a> `stateId`       | `string`                                            | The identifier of the state: node.id, or path.join('.')                                                                                                     | [packages/play-router/src/types.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L158) |
+| <a id="property-statepath"></a> `statePath`   | `string`[]                                          | The segments of the state path, from the root                                                                                                               | [packages/play-router/src/types.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L160) |

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

@@ -0,0 +1,19 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteMapOptions
+
+# Interface: RouteMapOptions
+
+Defined in: [packages/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`](CompileOptions.md)
+
+## 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.                                                                                                                                                                                                                                                                                                                                                         | [`CompileOptions`](CompileOptions.md).[`compiledCache`](CompileOptions.md#property-compiledcache) | [packages/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`](PatternCache.md)\<`string` \| `null`\>                                    | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone, of 500 entries in each of two generations. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createPatternCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | -                                                                                                 | [packages/play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L584)                   |
+| <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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [`CompileOptions`](CompileOptions.md).[`patternCache`](CompileOptions.md#property-patterncache)   | [packages/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-router/{interfaces → index/interfaces}/RouteMapping.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMapping
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteMapping
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-route-map.ts#L54)
+Defined in: [packages/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.
 
@@ -22,7 +22,7 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 ## Properties
 
-| 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/v3.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/v3.0.0/packages/play-router/src/base-route-map.ts#L56) |
+| Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                               |
+| --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L62) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [packages/play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L60) |

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

@@ -0,0 +1,12 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteMatch
+
+# Interface: RouteMatch
+
+Defined in: [packages/play-router/src/router-sync.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-sync.ts#L10)
+
+## Properties
+
+| Property                               | Type                              | Defined in                                                                                                                                         |
+| -------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\>    | [packages/play-router/src/router-sync.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-sync.ts#L12) |
+| <a id="property-to"></a> `to`          | `string` \| `null` \| `undefined` | [packages/play-router/src/router-sync.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-sync.ts#L11) |

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouteNode.md

@@ -1,21 +1,21 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteNode
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteNode
 
 # Interface: RouteNode
 
-Defined in: [play-router/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L84)
+Defined in: [packages/play-router/src/types.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L179)
 
 A node of the route tree. It represents one route
 
 ## Properties
 
-| Property                                  | Type                                                | Description                                                                                                                                                                                                                                   | Defined in                                                                                                                      |
-| ----------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-children"></a> `children` | `RouteNode`[]                                       | The child routes                                                                                                                                                                                                                              | [play-router/src/types.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L109) |
-| <a id="property-fullpath"></a> `fullPath` | `string`                                            | The complete absolute path from the root, for example `"/dashboard/overview"`. Always use `fullPath` for a match of a browser URL and for the construction of a route map. `createRouteMapFromTree` and `createRouteMap` both use this field. | [play-router/src/types.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L98)   |
-| <a id="property-id"></a> `id`             | `string`                                            | The unique identifier, which is the state ID                                                                                                                                                                                                  | [play-router/src/types.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L86)   |
-| <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | The original meta.route metadata                                                                                                                                                                                                              | [play-router/src/types.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L113) |
-| <a id="property-parent"></a> `parent`     | `RouteNode` \| `null`                               | The parent route. It is null for the root                                                                                                                                                                                                     | [play-router/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L111) |
-| <a id="property-path"></a> `path`         | `string`                                            | The raw segment of the route path, as `meta.route` declares it. It is relative, for example `"overview"`, or absolute, for example `"/dashboard"`. Never use it for a match of a URL: use `fullPath` for that.                                | [play-router/src/types.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L92)   |
-| <a id="property-pattern"></a> `pattern?`  | `string`                                            | The route pattern with its parameters, for example /profile/:userId, when path holds a parameter                                                                                                                                              | [play-router/src/types.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L100) |
-| <a id="property-routable"></a> `routable` | `boolean`                                           | It tells you if this state has a route, which means that it has a meta.route field. A state with a meta.route field can receive a play.route event                                                                                            | [play-router/src/types.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L107) |
-| <a id="property-stateid"></a> `stateId`   | `string`                                            | The XState state ID of this route                                                                                                                                                                                                             | [play-router/src/types.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L102) |
+| Property                                  | Type                                                | Description                                                                                                                                                                                                                                   | Defined in                                                                                                                               |
+| ----------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-children"></a> `children` | `RouteNode`[]                                       | The child routes                                                                                                                                                                                                                              | [packages/play-router/src/types.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L204) |
+| <a id="property-fullpath"></a> `fullPath` | `string`                                            | The complete absolute path from the root, for example `"/dashboard/overview"`. Always use `fullPath` for a match of a browser URL and for the construction of a route map. `createRouteMapFromTree` and `createRouteMap` both use this field. | [packages/play-router/src/types.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L193) |
+| <a id="property-id"></a> `id`             | `string`                                            | The unique identifier, which is the state ID                                                                                                                                                                                                  | [packages/play-router/src/types.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L181) |
+| <a id="property-metadata"></a> `metadata` | [`RouteMetadata`](../type-aliases/RouteMetadata.md) | The original meta.route metadata                                                                                                                                                                                                              | [packages/play-router/src/types.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L208) |
+| <a id="property-parent"></a> `parent`     | `RouteNode` \| `null`                               | The parent route. It is null for the root                                                                                                                                                                                                     | [packages/play-router/src/types.ts:206](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L206) |
+| <a id="property-path"></a> `path`         | `string`                                            | The raw segment of the route path, as `meta.route` declares it. It is relative, for example `"overview"`, or absolute, for example `"/dashboard"`. Never use it for a match of a URL: use `fullPath` for that.                                | [packages/play-router/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L187) |
+| <a id="property-pattern"></a> `pattern?`  | `string`                                            | The route pattern with its parameters, for example /profile/:userId, when path holds a parameter                                                                                                                                              | [packages/play-router/src/types.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L195) |
+| <a id="property-routable"></a> `routable` | `boolean`                                           | It tells you if this state has a route, which means that it has a meta.route field. A state with a meta.route field can receive a play.route event                                                                                            | [packages/play-router/src/types.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L202) |
+| <a id="property-stateid"></a> `stateId`   | `string`                                            | The XState state ID of this route                                                                                                                                                                                                             | [packages/play-router/src/types.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L197) |

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

@@ -0,0 +1,34 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteObject
+
+# Interface: RouteObject
+
+Defined in: [packages/play-router/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L33)
+
+A route object, with more metadata.
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+The additional metadata of the route: a title, a breadcrumb, and so on.
+
+CAUTION: `path`, `handler`, `reenter` and `data` are RESERVED. The routing layer
+reads those four names, and a release before this one read `path` alone. A state
+that carries its own `handler` value now throws an `InvalidRouteHandlerError` from
+`formatPlayRouteTransitions`, so the machine builds never; a state that carries its
+own `data` value now writes that value to `context.data`, where the `/context`
+projection of every view reads it. A `reenter` value is read as the FLAG of the
+generated transition, and the literal `true` alone turns the reentry on: the
+default is `false`, and a release before this one generated every transition with
+`reenter: true`. Give such a field another name.
+
+## Properties
+
+| Property                                 | Type                                                                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Defined in                                                                                                                               |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-data"></a> `data?`       | \| [`RouteData`](../type-aliases/RouteData.md) \| [`RouteDataResolver`](../type-aliases/RouteDataResolver.md) | The extra data that the state threads into its `play.route` event. The shape follows `WithDynamicParams` of XState, which is how XState itself parameterizes an action and a guard: the field holds a literal value, OR a function of `{ context, event }` that returns one. `// The literal form. It survives a serialization of the machine. meta: { route: { path: "/doc/:docId", data: { titleKey: "doc.view" } } } // The function form, for a value that depends on the route. meta: { route: { path: "/doc/:docId", data: ({ event }) => ({ title: `Document ${event.params?.docId}` }), }, }` The generated transition resolves the value and assigns it to the `data` field of the context, beside `params` and `query`. The data of a state does NOT merge with the data of its ancestors: each state declares the whole value that its own route carries. This field and [PlayRouteEvent.data](PlayRouteEvent.md#property-data) are two different things, and they meet in the resolver. This field is what the STATE declares, in its machine. `PlayRouteEvent.data` is what the SENDER of the event supplies, such as a router bridge or the code of an application. A resolver reads `event.data` and returns whatever mix of the two the state needs. CAUTION: the function form holds a function inside `meta`, and a function does not survive `JSON.stringify`. A machine that Stately Studio reads, or that a process sends over a wire, must use the literal form.                                                                                                                                                                                                                                                         | [packages/play-router/src/types.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L131) |
+| <a id="property-handler"></a> `handler?` | `"root"` \| `"local"` \| `"both"`                                                                             | Where the generated `play.route` transition sits. `"root"` is the default, and it is what XState does: `formatRouteTransitions` installs every route transition on the ROOT of the machine, and each one targets its state by the ID. A route from any state therefore reaches this state. The cost is that the root is the domain of the transition, so XState re-enters each ancestor on the path to the target, and those ancestors run their `entry` actions again although they stay active. `"local"` installs the transition on the PARENT of this state instead, and it targets this state relatively. XState offers the transitions of the deepest active state node first, so the parent answers the event itself and runs its `exit` and its `entry` actions NOT again. `"both"` installs one transition in each place. The local one answers while the parent is active, and the root one answers a route that arrives from outside the parent. Use `"both"` where an ancestor holds an `entry` action that must run one time for each real entry, such as an analytics event or an audit record. CAUTION: `"local"` makes this state reachable by a route ONLY while its parent is active. A `play.route` event that arrives from anywhere else matches no transition and the actor does not move. A browser URL for this state therefore leaves the URL and the actor divergent. Choose `"local"` to SCOPE a route on purpose, for example a step that a person reaches only inside its wizard. Choose `"both"` where the state must stay reachable from everywhere. The field has no effect on a state whose parent IS the root: the root transition of such a state is already local to its parent, so all three values agree. | [packages/play-router/src/types.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L95)   |
+| <a id="property-path"></a> `path`        | `string`                                                                                                      | The template of the route path, for example `"/user/:id"`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [packages/play-router/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L35)   |
+| <a id="property-reenter"></a> `reenter?` | `boolean`                                                                                                     | The `reenter` flag of the generated `play.route` transition. The default is `false`, which is also the default of XState. The flag spares the DOMAIN of the transition, and not every ancestor that stays active. Under the default placement `handler: "root"` the domain is the root of the machine, so `false` spares the root alone: each ancestor BETWEEN the root and the target still runs its `exit` and its `entry` actions, because XState re-enters every descendant of the domain that lies on the path to the target. A move between two siblings therefore still runs the `entry` action of their shared parent. [RouteObject.handler](#property-handler) is the field that spares those intermediate ancestors: `"local"` and `"both"` move the domain down to the parent of the state. Use the two fields together where an `entry` action must run one time for each state that the actor really enters. Set the field to `true` where the domain must run its `entry` actions again on every route to a descendant. The flag does not decide the destination. The value of the machine after a route is identical under both settings. A route to a state that has children still enters the `initial` child of that state, because the generated transition targets the state by its id, and XState enters the initial child of an id target under both settings. **See** [Play RFC](../../../../../rfc/play.md)                                                                                                                                                                                                                                                                                                            | [packages/play-router/src/types.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L64)   |

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

@@ -0,0 +1,27 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteTree
+
+# Interface: RouteTree\<TGraph\>
+
+Defined in: [packages/play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L218)
+
+The complete route tree, with its lookup maps
+
+It gives you the map between a state ID and a URL path, in both directions:
+
+- byStateId: it maps each state ID to its route node, for the target of a play.route event
+- byPath: it maps each URL path to its route node, for the browser navigation
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `TGraph`       | `unknown`    |
+
+## Properties
+
+| Property                                    | Type                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Defined in                                                                                                                               |
+| ------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-bypath"></a> `byPath`       | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | The map from a complete path to its route node. It gives you the state ID of a URL path, for the target of a play.route event                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L230) |
+| <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | The map from a state ID to its route node. It gives you the URL path of a state ID, for the update of the browser URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L225) |
+| <a id="property-graph"></a> `graph?`        | `TGraph`                                       | The graph of the state machine, for an advanced query. `TGraph` carries its type, and this package names none: a route tree is a map from a path to a state, and the graph of a MACHINE belongs to the package that reads a machine. `extractMachineRoutes` of `@xmachines/play-router/xstate` answers `RouteTree<MachineGraph>`, so a consumer of that function loses no type. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; // `tree`comes from`extractMachineRoutes`of`@xmachines/play-router/xstate` const successors = getSuccessors(tree.graph!, "myMachine.home");` | [packages/play-router/src/types.ts:246](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L246) |
+| <a id="property-root"></a> `root`           | [`RouteNode`](RouteNode.md)                    | The root node of the routes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L220) |

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

@@ -0,0 +1,55 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteWatcherHandle
+
+# Interface: RouteWatcherHandle
+
+Defined in: [packages/play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L91)
+
+The narrow interface of the atom watcher. `RouterBridgeBase` uses it to
+observe each change of `actor.currentRoute`.
+
+The interface hides the whole subscription surface of the atom. It exposes the
+two operations that `RouterBridgeBase` needs:
+
+- `watch(atom)` — it starts the watch of one atom
+- `unwatch()` — it stops the watch and frees the resources
+
+A framework adapter subclass touches this handle never. `RouterBridgeBase` makes
+it and manages it internally.
+
+## Methods
+
+### unwatch()
+
+```ts
+unwatch(): void;
+```
+
+Defined in: [packages/play-router/src/router-bridge-base.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L95)
+
+Stops the observation and frees the watcher.
+
+#### Returns
+
+`void`
+
+---
+
+### watch()
+
+```ts
+watch(atom): void;
+```
+
+Defined in: [packages/play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L93)
+
+Arms the watcher on the given atom.
+
+#### Parameters
+
+| Parameter | Type                                                                                  |
+| --------- | ------------------------------------------------------------------------------------- |
+| `atom`    | [`ReadonlyAtom`](../../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> |
+
+#### Returns
+
+`void`

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouterBridge.md

@@ -1,19 +1,19 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouterBridge
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouterBridge
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L359)
+Defined in: [packages/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,31 +22,29 @@ 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;
 	}
 }
 ```
 
 ## See
 
-[Play RFC](../../../../rfc/play.md) - invariant INV-04
+[Play RFC](../../../../../rfc/play.md) - invariant INV-04
 
 ## Extended by
 
@@ -60,12 +58,12 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:376](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L376)
+Defined in: [packages/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
@@ -79,7 +77,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
 ```
 
 ---
@@ -90,12 +88,12 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L392)
+Defined in: [packages/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-router/index/interfaces/RouterBridgeOptions.md

@@ -0,0 +1,31 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouterBridgeOptions
+
+# Interface: RouterBridgeOptions
+
+Defined in: [packages/play-router/src/router-bridge-base.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L77)
+
+What a bridge takes beside the actor and the route map.
+
+It is [BasePathOptions](BasePathOptions.md) with the caches of [CompileOptions](CompileOptions.md) added: the parse
+cache AND the compiled cache. A base path and a cache are two different questions, and
+this type joins them at the ONE place that asks both: the constructor of a bridge.
+
+## Extends
+
+- [`BasePathOptions`](BasePathOptions.md).[`CompileOptions`](CompileOptions.md)
+
+## Extended by
+
+- [`OpenProviderBridgeArgs`](OpenProviderBridgeArgs.md)
+- [`ConnectRouterOptions`](../../../play-dom-router/interfaces/ConnectRouterOptions.md)
+- [`ConnectRouterOptions`](../../../play-sveltekit-router/interfaces/ConnectRouterOptions.md)
+- [`ConnectRouterOptions`](../../../play-svelte-spa-router/interfaces/ConnectRouterOptions.md)
+
+## Properties
+
+| Property                                               | Modifier   | Type                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Inherited from                                                                                         | Defined in                                                                                                                                                 |
+| ------------------------------------------------------ | ---------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                                                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](BasePathOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix", which is the behaviour of every release before this option existed.                                                 | [`BasePathOptions`](BasePathOptions.md).[`basePath`](BasePathOptions.md#property-basepath)             | [packages/play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.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](BasePathOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [`BasePathOptions`](BasePathOptions.md).[`basePathParams`](BasePathOptions.md#property-basepathparams) | [packages/play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/base-path.ts#L76)                   |
+| <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.                                                                                                   | [`CompileOptions`](CompileOptions.md).[`compiledCache`](CompileOptions.md#property-compiledcache)      | [packages/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-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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`CompileOptions`](CompileOptions.md).[`patternCache`](CompileOptions.md#property-patterncache)        | [packages/play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-pattern/src/cache.ts#L40)                   |