@xmachines/docs 1.0.0-beta.10

package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md

@@ -0,0 +1,348 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / TanStackReactRouterBridge
+
+# Class: TanStackReactRouterBridge
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L78)
+
+TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
+
+## Remarks
+
+Extends RouterBridgeBase to handle all common lifecycle and sync logic.
+Only 3 TanStack-specific methods are implemented here.
+
+Subscribes to router.history (not router.subscribe("onBeforeLoad")) so that
+back/forward browser navigation (popstate events) are also captured. The
+router.subscribe("onBeforeLoad") approach only works when TanStack's
+Transitioner component is mounted (i.e. inside a full <RouterProvider>).
+Since this bridge is used without <RouterProvider>, we must subscribe to
+the underlying history object directly — which is exactly what Transitioner
+does internally: `router.history.subscribe(router.load)`.
+
+Architectural Invariants:
+
+- INV-02 (Passive Infrastructure): Router reflects actor state, never decides
+- Actor validates all navigation via guards before URL changes
+
+## Example
+
+```typescript
+const bridge = new TanStackReactRouterBridge(router, actor, routeMap);
+bridge.connect();
+return () => bridge.disconnect();
+```
+
+## Extends
+
+- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new TanStackReactRouterBridge(
+   router,
+   actor,
+   routeMap): TanStackReactRouterBridge;
+```
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L88)
+
+Create TanStack React Router bridge
+
+#### Parameters
+
+| Parameter  | Type                                                                                                                                    | Description                                       |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
+| `router`   | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                                                                           | TanStack React Router instance                    |
+| `actor`    | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance                          |
+| `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                               | Bidirectional mapping between state IDs and paths |
+
+#### Returns
+
+`TanStackReactRouterBridge`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
+
+## Properties
+
+| Property                                                              | Modifier    | Type                                                                                                                                    | Description                                           | Inherited from                                                                                                                                                                | Defined in                                  |
+| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | Actor with currentRoute signal and send method        | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | play-router/dist/router-bridge-base.d.ts:55 |
+| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | play-router/dist/router-bridge-base.d.ts:61 |
+| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | play-router/dist/router-bridge-base.d.ts:60 |
+| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                                                                               | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:63 |
+| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string`                                                                                                                                | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | play-router/dist/router-bridge-base.d.ts:62 |
+| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                                                                | Bidirectional route map for stateId ↔ path resolution | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | play-router/dist/router-bridge-base.d.ts:56 |
+| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:58 |
+| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                                                                       | -                                                     | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:57 |
+| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null`                                     | -                                                     | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | play-router/dist/router-bridge-base.d.ts:64 |
+
+## Methods
+
+### connect()
+
+```ts
+connect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:81
+
+Connect the router bridge to the Actor.
+
+Sets up the TC39 Signal watcher for actor → router direction and
+starts watching router changes (framework-specific).
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
+
+---
+
+### disconnect()
+
+```ts
+disconnect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:87
+
+Disconnect the router bridge from the Actor.
+
+Stops signal watching and unregisters framework-specific router listener.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
+
+---
+
+### extractParams()
+
+```ts
+protected extractParams(pathname, stateId): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:134
+
+Extract path parameters from URL using the URLPattern API.
+
+Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
+library. If `URLPattern` is unavailable (Node.js < 24, older browsers without a
+polyfill), this method returns `{}` silently (graceful degradation — routing still
+works, params will be empty).
+
+#### Parameters
+
+| Parameter  | Type     | Description                                       |
+| ---------- | -------- | ------------------------------------------------- |
+| `pathname` | `string` | The actual URL path (e.g., '/profile/john')       |
+| `stateId`  | `string` | The matched state ID for looking up route pattern |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted path parameters, or empty object if URLPattern is unavailable or no match
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
+
+---
+
+### extractQuery()
+
+```ts
+protected extractQuery(search): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:141
+
+Extract query parameters from URL search string.
+
+#### Parameters
+
+| Parameter | Type     | Description                                      |
+| --------- | -------- | ------------------------------------------------ |
+| `search`  | `string` | URL search string (e.g., '?tab=security&page=1') |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted query parameters or empty object
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
+
+---
+
+### getInitialRouterPath()
+
+```ts
+protected getInitialRouterPath(): string | null;
+```
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L110)
+
+Read the router's current pathname for initial sync.
+
+Called once in connect() to handle cold-load / deep-link scenarios where
+the URL differs from the actor's initial state.
+
+#### Returns
+
+`string` \| `null`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
+
+---
+
+### navigateRouter()
+
+```ts
+protected navigateRouter(path): void;
+```
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L100)
+
+Navigate the framework router to the given path.
+
+Called when actor's currentRoute signal changes to a new path.
+Must trigger the framework router's navigation (e.g., router.navigate(path)).
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
+
+---
+
+### syncActorFromRouter()
+
+```ts
+protected syncActorFromRouter(pathname, search?): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:101
+
+Sync actor state when router location changes.
+
+Sends play.route event to actor with resolved stateId, params, and query.
+Prevents circular updates via isProcessingNavigation flag.
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `pathname` | `string` |
+| `search?`  | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
+
+---
+
+### syncRouterFromActor()
+
+```ts
+protected syncRouterFromActor(route): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:94
+
+Sync router location when actor route signal changes.
+
+Calls navigateRouter() for framework-specific navigation.
+Prevents circular updates via isProcessingNavigation flag.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `route`   | `unknown` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
+
+---
+
+### unwatchRouterChanges()
+
+```ts
+protected unwatchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L131)
+
+Stop watching for router location changes.
+
+Called by disconnect(). Should clean up the framework-specific subscription.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
+
+---
+
+### watchRouterChanges()
+
+```ts
+protected watchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L123)
+
+Subscribe to ALL navigation events via router.history.
+
+router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
+covering both link clicks and browser back/forward button presses.
+
+The subscriber callback receives { location, action } where location is the
+new history location with pathname and search already updated.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)

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

@@ -0,0 +1,19 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouterProvider
+
+# Function: PlayRouterProvider()
+
+```ts
+function PlayRouterProvider(__namedParameters): Element;
+```
+
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L38)
+
+## Parameters
+
+| Parameter           | Type                                                                  |
+| ------------------- | --------------------------------------------------------------------- |
+| `__namedParameters` | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md) |
+
+## Returns
+
+`Element`

package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md

@@ -0,0 +1,53 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / createRouteMap
+
+# Function: createRouteMap()
+
+```ts
+function createRouteMap(routeTree): RouteMap;
+```
+
+Defined in: play-router/dist/create-route-map.d.ts:65
+
+Create a RouteMap from a RouteTree for efficient path lookups.
+
+Architecture:
+
+- Pure function - no side effects
+- O(1) lookups for exact matches via Map
+- O(k) bucket-indexed pattern matching with URLPattern, where k = routes in the
+  first-segment bucket (typically << total routes)
+- Returns formatted state IDs (with # prefix)
+- Extracts params from matched patterns
+
+**URLPattern requirement:** Dynamic route pattern matching requires `URLPattern`
+to be available on `globalThis`. On Node.js < 24 and older browsers, load a polyfill
+before calling this function:
+
+```typescript
+import "urlpattern-polyfill"; // before importing @xmachines/play-router
+```
+
+If `URLPattern` is unavailable, parameterized routes will not match and a
+`console.warn` is emitted. Static (exact) routes are unaffected.
+
+Usage:
+
+```typescript
+const routeTree = extractMachineRoutes(machine);
+const routeMap = createRouteMap(routeTree);
+
+const { to, params } = routeMap.resolve("/settings/account");
+if (to) {
+	actor.send({ type: "play.route", to, params });
+}
+```
+
+## Parameters
+
+| Parameter   | Type                                                     |
+| ----------- | -------------------------------------------------------- |
+| `routeTree` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) |
+
+## Returns
+
+[`RouteMap`](../../play-router/interfaces/RouteMap.md)

package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md

@@ -0,0 +1,35 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / createRouteMapFromTree
+
+# Function: createRouteMapFromTree()
+
+```ts
+function createRouteMapFromTree(routeTree): RouteMap;
+```
+
+Defined in: [play-tanstack-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/route-map.ts#L73)
+
+Create RouteMap from RouteTree
+
+Converts XMachines route tree to RouteMap for use with router adapters.
+
+## Parameters
+
+| Parameter   | Type                                                     | Description                            |
+| ----------- | -------------------------------------------------------- | -------------------------------------- |
+| `routeTree` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | Route tree from extractMachineRoutes() |
+
+## Returns
+
+[`RouteMap`](../classes/RouteMap.md)
+
+RouteMap instance
+
+## Example
+
+```typescript
+import { extractMachineRoutes } from "@xmachines/play-router";
+import { createRouteMapFromTree } from "@xmachines/play-tanstack-react-router";
+
+const routeTree = extractMachineRoutes(machine);
+const routeMap = createRouteMapFromTree(routeTree);
+```

package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md

@@ -0,0 +1,38 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / extractParams
+
+# Function: extractParams()
+
+```ts
+function extractParams(pathname, pattern): Record<string, string>;
+```
+
+Defined in: [play-tanstack-react-router/src/extract-params.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/extract-params.ts#L29)
+
+Extract route parameters from URL path based on route pattern using URLPattern API
+
+## Parameters
+
+| Parameter  | Type     | Description                                          |
+| ---------- | -------- | ---------------------------------------------------- |
+| `pathname` | `string` | Actual URL path (e.g., "/profile/123")               |
+| `pattern`  | `string` | Route pattern with params (e.g., "/profile/:userId") |
+
+## Returns
+
+`Record`\<`string`, `string`\>
+
+Object with extracted parameters
+
+## Example
+
+```typescript
+extractParams("/profile/123", "/profile/:userId");
+// Returns: { userId: "123" }
+
+extractParams("/api/123", "/api/:id(\\d+)");
+// Returns: { id: "123" }
+// Validates numeric constraint via URLPattern
+
+extractParams("/docs/intro", "/docs/*");
+// Returns: { "0": "intro" }
+```

package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md

@@ -0,0 +1,33 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / extractQueryParams
+
+# Function: extractQueryParams()
+
+```ts
+function extractQueryParams(search): Record<string, string>;
+```
+
+Defined in: [play-tanstack-react-router/src/extract-params.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/extract-params.ts#L68)
+
+Extract query parameters from search string
+
+## Parameters
+
+| Parameter | Type     | Description                                                                      |
+| --------- | -------- | -------------------------------------------------------------------------------- |
+| `search`  | `string` | Query string with or without leading ? (e.g., "?tab=settings" or "tab=settings") |
+
+## Returns
+
+`Record`\<`string`, `string`\>
+
+Object mapping query parameter names to values
+
+## Example
+
+```typescript
+extractQueryParams("?tab=settings&theme=dark");
+// Returns: { tab: "settings", theme: "dark" }
+
+extractQueryParams("q=hello%20world");
+// Returns: { q: "hello world" } (auto-decoded)
+```

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

@@ -0,0 +1,119 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouteEvent
+
+# Interface: PlayRouteEvent
+
+Defined in: play-router/dist/types.d.ts:182
+
+Enhanced routing event with parameter and query support
+
+Unified routing event used throughout the Play architecture. Supports parameter-aware
+navigation patterns (e.g., `/profile/:userId`) for dynamic route segments.
+
+**Architectural Context:** Implements **Passive Infrastructure (INV-04)** by representing
+user navigation intent that the Actor evaluates through guards. Infrastructure proposes
+via `play.route` events, Actor decides via state machine transitions.
+
+**Browser Navigation Flow:**
+
+1. Browser fires `popstate`
+2. Router adapter resolves URL to route target
+3. Adapter sends `PlayRouteEvent` to Actor
+4. Actor validates transition via state machine guards
+
+## Param
+
+Event discriminator (always "play.route")
+
+## Param
+
+Target state ID with # prefix (e.g., '#home', '#profile')
+
+## Param
+
+Merged path + query parameters (path parameters win conflicts)
+
+## Param
+
+Query parameters only (isolated from path params)
+
+## Param
+
+Full URLPattern match result for debugging/observability (optional)
+
+## Examples
+
+Combining base and routing events
+
+```typescript
+import type { PlayEvent } from "@xmachines/play";
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+type AppEvent = PlayEvent | PlayRouteEvent;
+```
+
+Basic navigation to a route
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#home",
+};
+actor.send(event);
+```
+
+Navigation with route parameters
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#profile",
+	params: { userId: "123" },
+};
+actor.send(event);
+// Resolves to route: /profile/123
+```
+
+Navigation with query parameters
+
+```typescript
+import type { PlayRouteEvent } from "@xmachines/play-router";
+
+const event: PlayRouteEvent = {
+	type: "play.route",
+	to: "#settings",
+	params: { section: "profile" }, // Merged: path + query
+	query: { tab: "security" }, // Query-only
+};
+actor.send(event);
+// Resolves to route: /settings/profile?tab=security
+```
+
+## See
+
+[RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
+
+## Remarks
+
+Use `play.route` when you need parameter-aware navigation with the `route: {}`
+config pattern on your state machine nodes. The `match` field exposes the full
+URLPatternResult for advanced use cases (debugging, pattern analysis).
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property                               | Modifier   | Type                           | Defined in                      |
+| -------------------------------------- | ---------- | ------------------------------ | ------------------------------- |
+| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | play-router/dist/types.d.ts:187 |
+| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:185 |
+| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | play-router/dist/types.d.ts:186 |
+| <a id="property-to"></a> `to`          | `readonly` | `string`                       | play-router/dist/types.d.ts:184 |
+| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | play-router/dist/types.d.ts:183 |

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

@@ -0,0 +1,14 @@
+[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouterProviderProps
+
+# Interface: PlayRouterProviderProps
+
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
+
+## Properties
+
+| Property                                  | Type                                                                                                                                                                                            | Defined in                                                                                                                                                                                                                    |
+| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`       | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) & [`Viewable`](../../play-actor/interfaces/Viewable.md) | [play-tanstack-react-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L29) |
+| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode`                                                                                                                                                              | [play-tanstack-react-router/src/play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L32) |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md)                                                                                                                                                            | [play-tanstack-react-router/src/play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L31) |
+| <a id="property-router"></a> `router`     | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                                                                                                                                   | [play-tanstack-react-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L30) |