@xmachines/docs 1.0.0-beta.10

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

@@ -0,0 +1,32 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / detectDuplicateRoutes
+
+# Function: detectDuplicateRoutes()
+
+```ts
+function detectDuplicateRoutes(routes): void;
+```
+
+Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/validate-routes.ts#L51)
+
+Detect duplicate route paths
+
+THROWS ERROR when multiple states share the same route path.
+
+Rationale: URL-based routing requires one-to-one mapping between URLs and states.
+Multiple states at the same path creates ambiguity for browser navigation (back button,
+direct URL access). Use different paths for different states, or single state with
+conditional rendering.
+
+## Parameters
+
+| Parameter | Type                                        | Description                          |
+| --------- | ------------------------------------------- | ------------------------------------ |
+| `routes`  | [`RouteInfo`](../interfaces/RouteInfo.md)[] | Array of extracted RouteInfo objects |
+
+## Returns
+
+`void`
+
+## Throws
+
+If duplicate route paths are detected

package/api/@xmachines/play-router/functions/extractMachineRoutes.md

@@ -0,0 +1,64 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractMachineRoutes
+
+# Function: extractMachineRoutes()
+
+```ts
+function extractMachineRoutes(machine): RouteTree;
+```
+
+Defined in: [extract-routes.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/extract-routes.ts#L45)
+
+Extract complete route tree from state machine graph
+
+Crawls machine starting from root, visits all state nodes (including nested
+and parallel), extracts meta.route metadata, validates route references,
+and builds hierarchical tree.
+
+## Parameters
+
+| Parameter | Type              | Description             |
+| --------- | ----------------- | ----------------------- |
+| `machine` | `AnyStateMachine` | XState v5 state machine |
+
+## Returns
+
+[`RouteTree`](../interfaces/RouteTree.md)
+
+Route tree with root, byStateId map, and byPath map
+
+## Throws
+
+If route references non-existent state
+
+## Throws
+
+If route path is malformed (doesn't start with /)
+
+## Throws
+
+If parallel states define conflicting routes
+
+## Example
+
+```typescript
+import { createMachine } from "xstate";
+import { extractMachineRoutes } from "@xmachines/play-router";
+
+const machine = createMachine({
+	initial: "home",
+	states: {
+		home: { id: "home", meta: { route: "/" } },
+		dashboard: {
+			id: "dashboard",
+			meta: { route: "/dashboard" },
+			initial: "overview",
+			states: {
+				overview: { id: "overview", meta: { route: "/overview" } },
+			},
+		},
+	},
+});
+
+const tree = extractMachineRoutes(machine);
+console.log(tree.byPath.get("/dashboard/overview"));
+```

package/api/@xmachines/play-router/functions/extractRoute.md

@@ -0,0 +1,45 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / extractRoute
+
+# Function: extractRoute()
+
+```ts
+function extractRoute(node, path, stateMap): RouteInfo | null;
+```
+
+Defined in: [extract-route.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/extract-route.ts#L26)
+
+Extract route information from state node with validation
+
+States with meta.route are "routable" - they can receive play.route events
+(when machine is wrapped with formatPlayRouteTransitions).
+
+## Parameters
+
+| Parameter  | Type                                                              | Description                                       |
+| ---------- | ----------------------------------------------------------------- | ------------------------------------------------- |
+| `node`     | `StateNode`                                                       | XState StateNode to extract route from            |
+| `path`     | `string`[]                                                        | State path segments from root                     |
+| `stateMap` | `Map`\<`string`, `StateNode`\<`MachineContext`, `EventObject`\>\> | Map of all state IDs to StateNodes for validation |
+
+## Returns
+
+[`RouteInfo`](../interfaces/RouteInfo.md) \| `null`
+
+RouteInfo if state has meta.route, null otherwise
+
+## Throws
+
+If route path is malformed (missing leading /)
+
+## Throws
+
+If route references non-existent state
+
+## Example
+
+```typescript
+const node = {
+	id: "dashboard",
+	meta: { route: "/dashboard" },
+};
+```

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

@@ -0,0 +1,37 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteById
+
+# Function: findRouteById()
+
+```ts
+function findRouteById(tree, id): RouteNode | undefined;
+```
+
+Defined in: [index.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/index.ts#L65)
+
+Find route node by state ID
+
+Looks up route node using the state's ID property. Used to get URL path
+from state ID for browser URL sync after play.route transitions.
+
+## Parameters
+
+| Parameter | Type                                      | Description                                      |
+| --------- | ----------------------------------------- | ------------------------------------------------ |
+| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | Route tree from extractMachineRoutes             |
+| `id`      | `string`                                  | State ID (e.g., 'dashboard', 'settings.profile') |
+
+## Returns
+
+[`RouteNode`](../interfaces/RouteNode.md) \| `undefined`
+
+Route node if found, undefined otherwise
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+const node = findRouteById(tree, "dashboard");
+if (node) {
+	console.log(node.fullPath); // '/dashboard'
+}
+```

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

@@ -0,0 +1,39 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / findRouteByPath
+
+# Function: findRouteByPath()
+
+```ts
+function findRouteByPath(tree, path): RouteNode | undefined;
+```
+
+Defined in: [index.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/index.ts#L157)
+
+Find route node by URL path
+
+Looks up route node using the URL path. Used to get state ID from browser
+URL for sending play.route events on navigation.
+
+When multiple states share the same path (e.g., root and a state both at "/"),
+prefers routable nodes (with meta.route) over non-routable nodes.
+
+Supports pattern matching for dynamic routes (e.g., '/settings/:section?').
+
+## Parameters
+
+| Parameter | Type                                      | Description                                        |
+| --------- | ----------------------------------------- | -------------------------------------------------- |
+| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | Route tree from extractMachineRoutes               |
+| `path`    | `string`                                  | URL path (e.g., '/dashboard', '/settings/profile') |
+
+## Returns
+
+[`RouteNode`](../interfaces/RouteNode.md) \| `undefined`
+
+Route node if found, undefined otherwise
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+const node = findRouteByPath(tree, "/dashboard");
+```

package/api/@xmachines/play-router/functions/getNavigableRoutes.md

@@ -0,0 +1,35 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getNavigableRoutes
+
+# Function: getNavigableRoutes()
+
+```ts
+function getNavigableRoutes(tree, stateId): RouteNode[];
+```
+
+Defined in: [query.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/query.ts#L20)
+
+Get all routes navigable from given state
+
+Returns child routes of the specified state. Future enhancement will
+include sibling routes reachable via transitions.
+
+## Parameters
+
+| Parameter | Type                                      | Description                            |
+| --------- | ----------------------------------------- | -------------------------------------- |
+| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | Route tree from extractMachineRoutes() |
+| `stateId` | `string`                                  | Current state ID                       |
+
+## Returns
+
+[`RouteNode`](../interfaces/RouteNode.md)[]
+
+Array of route nodes reachable from state
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+const routes = getNavigableRoutes(tree, "dashboard");
+// [{ id: 'overview', path: '/overview', ... }, { id: 'settings', ... }]
+```

package/api/@xmachines/play-router/functions/getRoutableRoutes.md

@@ -0,0 +1,39 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
+
+# Function: getRoutableRoutes()
+
+```ts
+function getRoutableRoutes(tree): RouteNode[];
+```
+
+Defined in: [query.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/query.ts#L50)
+
+Get all routable routes from tree as flat array
+
+Returns all routes that have meta.route defined, excluding non-routable
+states and the synthetic root node. Useful for dynamically generating
+router configurations in framework adapters.
+
+## Parameters
+
+| Parameter | Type                                      | Description                            |
+| --------- | ----------------------------------------- | -------------------------------------- |
+| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | Route tree from extractMachineRoutes() |
+
+## Returns
+
+[`RouteNode`](../interfaces/RouteNode.md)[]
+
+Array of routable route nodes with path and stateId
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+const routes = getRoutableRoutes(tree);
+// [
+//   { path: '/', stateId: '#home', ... },
+//   { path: '/about', stateId: '#about', ... },
+//   { path: '/profile/:userId', stateId: '#profile', ... }
+// ]
+```

package/api/@xmachines/play-router/functions/routeExists.md

@@ -0,0 +1,26 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
+
+# Function: routeExists()
+
+```ts
+function routeExists(tree, path): boolean;
+```
+
+Defined in: [query.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/query.ts#L72)
+
+Validate route path exists in tree
+
+Checks if path has corresponding state with meta.route.
+
+## Parameters
+
+| Parameter | Type                                      | Description                                   |
+| --------- | ----------------------------------------- | --------------------------------------------- |
+| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | Route tree from extractMachineRoutes()        |
+| `path`    | `string`                                  | Full route path (e.g., '/dashboard/settings') |
+
+## Returns
+
+`boolean`
+
+true if path exists, false otherwise

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

@@ -0,0 +1,29 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateRouteFormat
+
+# Function: validateRouteFormat()
+
+```ts
+function validateRouteFormat(routePath, stateId): void;
+```
+
+Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/validate-routes.ts#L14)
+
+Validate route path format
+
+Ensures route paths start with "/" (absolute or relative).
+Per Route Protocol spec, all routes must have explicit path structure.
+
+## Parameters
+
+| Parameter   | Type     | Description                         |
+| ----------- | -------- | ----------------------------------- |
+| `routePath` | `string` | Route path to validate              |
+| `stateId`   | `string` | State identifier for error messages |
+
+## Returns
+
+`void`
+
+## Throws
+
+If route path doesn't start with /

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

@@ -0,0 +1,29 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / validateStateExists
+
+# Function: validateStateExists()
+
+```ts
+function validateStateExists(stateId, stateMap): void;
+```
+
+Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/validate-routes.ts#L32)
+
+Validate state exists in state map
+
+Ensures referenced state IDs exist in the machine graph.
+Build-time validation prevents broken route references.
+
+## Parameters
+
+| Parameter  | Type                                                              | Description                        |
+| ---------- | ----------------------------------------------------------------- | ---------------------------------- |
+| `stateId`  | `string`                                                          | State identifier to validate       |
+| `stateMap` | `Map`\<`string`, `StateNode`\<`MachineContext`, `EventObject`\>\> | Map of all state IDs to StateNodes |
+
+## Returns
+
+`void`
+
+## Throws
+
+If state ID doesn't exist in map

package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md

@@ -0,0 +1,27 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BaseRouteMapping
+
+# Interface: BaseRouteMapping
+
+Defined in: [base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/base-route-map.ts#L28)
+
+A single state ID ↔ path mapping entry.
+
+Both fields are `readonly` — mappings are immutable once passed to `BaseRouteMap`.
+Adapter packages re-export a structurally compatible `RouteMapping` type under
+their own name. This type is published from `@xmachines/play-router` as
+`BaseRouteMapping` to avoid name collisions with those adapter-local types.
+
+## Example
+
+```typescript
+const mapping: BaseRouteMapping = { stateId: "home", path: "/" };
+const paramMapping: BaseRouteMapping = { stateId: "profile", path: "/profile/:userId" };
+const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/settings/:section?" };
+```
+
+## Properties
+
+| Property                                | Modifier   | Type     | Description                                                                   | Defined in                                                                                                                                                        |
+| --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/base-route-map.ts#L32) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [base-route-map.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/base-route-map.ts#L30) |

package/api/@xmachines/play-router/interfaces/BrowserHistory.md

@@ -0,0 +1,172 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BrowserHistory
+
+# Interface: BrowserHistory
+
+Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L1)
+
+## Properties
+
+| Property                                  | Modifier   | Type      | Description                | Defined in                                                                                                                                                                      |
+| ----------------------------------------- | ---------- | --------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-location"></a> `location` | `readonly` | `object`  | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L5) |
+| `location.hash`                           | `public`   | `string`  | -                          | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L8) |
+| `location.pathname`                       | `public`   | `string`  | -                          | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L6) |
+| `location.search`                         | `public`   | `string`  | -                          | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L7) |
+| `location.state`                          | `public`   | `unknown` | -                          | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L9) |
+
+## Methods
+
+### back()
+
+```ts
+back(): void;
+```
+
+Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L26)
+
+#### Returns
+
+`void`
+
+---
+
+### createHref()
+
+```ts
+createHref(path): string;
+```
+
+Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L38)
+
+Create href from path
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+#### Returns
+
+`string`
+
+---
+
+### destroy()
+
+```ts
+destroy(): void;
+```
+
+Defined in: [create-browser-history.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L43)
+
+Cleanup
+
+#### Returns
+
+`void`
+
+---
+
+### forward()
+
+```ts
+forward(): void;
+```
+
+Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L27)
+
+#### Returns
+
+`void`
+
+---
+
+### go()
+
+```ts
+go(delta): void;
+```
+
+Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L25)
+
+Go back/forward
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `delta`   | `number` |
+
+#### Returns
+
+`void`
+
+---
+
+### push()
+
+```ts
+push(path, state?): void;
+```
+
+Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L15)
+
+Push new URL to history
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `path`    | `string`  |
+| `state?`  | `unknown` |
+
+#### Returns
+
+`void`
+
+---
+
+### replace()
+
+```ts
+replace(path, state?): void;
+```
+
+Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L20)
+
+Replace current URL in history
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `path`    | `string`  |
+| `state?`  | `unknown` |
+
+#### Returns
+
+`void`
+
+---
+
+### subscribe()
+
+```ts
+subscribe(listener): () => void;
+```
+
+Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L33)
+
+Subscribe to history changes
+Returns unsubscribe function
+
+#### Parameters
+
+| Parameter  | Type                   |
+| ---------- | ---------------------- |
+| `listener` | (`location`) => `void` |
+
+#### Returns
+
+() => `void`

package/api/@xmachines/play-router/interfaces/BrowserWindow.md

@@ -0,0 +1,69 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BrowserWindow
+
+# Interface: BrowserWindow
+
+Defined in: [create-browser-history.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L55)
+
+Minimal window interface for createBrowserHistory
+
+Structural interface covering only the properties actually used.
+Accepts Window, JSDOM window, or any compatible test double.
+Avoids coupling to `Window & typeof globalThis` which varies across environments.
+
+## Properties
+
+| Property                                  | Modifier   | Type      | Defined in                                                                                                                                                                        |
+| ----------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-history"></a> `history`   | `public`   | `object`  | [create-browser-history.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L56) |
+| `history.state`                           | `readonly` | `unknown` | [create-browser-history.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L57) |
+| `history.back`                            | `public`   | `void`    | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L61) |
+| `history.forward`                         | `public`   | `void`    | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L62) |
+| `history.go`                              | `public`   | `void`    | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L60) |
+| `history.pushState`                       | `public`   | `void`    | [create-browser-history.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L58) |
+| `history.replaceState`                    | `public`   | `void`    | [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L59) |
+| <a id="property-location"></a> `location` | `public`   | `object`  | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L64) |
+| `location.hash`                           | `readonly` | `string`  | [create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L67) |
+| `location.pathname`                       | `readonly` | `string`  | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L65) |
+| `location.search`                         | `readonly` | `string`  | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L66) |
+
+## Methods
+
+### addEventListener()
+
+```ts
+addEventListener(type, listener): void;
+```
+
+Defined in: [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L69)
+
+#### Parameters
+
+| Parameter  | Type         |
+| ---------- | ------------ |
+| `type`     | `"popstate"` |
+| `listener` | () => `void` |
+
+#### Returns
+
+`void`
+
+---
+
+### removeEventListener()
+
+```ts
+removeEventListener(type, listener): void;
+```
+
+Defined in: [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L70)
+
+#### Parameters
+
+| Parameter  | Type         |
+| ---------- | ------------ |
+| `type`     | `"popstate"` |
+| `listener` | () => `void` |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,13 @@
+[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / ConnectRouterOptions
+
+# Interface: ConnectRouterOptions
+
+Defined in: [connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L7)
+
+## Properties
+
+| Property                                  | Type                                                                                                                                    | Defined in                                                                                                                                                        |
+| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`       | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L8)   |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                               | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L10) |
+| <a id="property-router"></a> `router`     | [`VanillaRouter`](VanillaRouter.md)                                                                                                     | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L9)   |