@xmachines/docs 1.0.0-beta.53 → 1.0.0-beta.55

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

@@ -1,53 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMatcher
-
-# Function: createRouteMatcher()
-
-```ts
-function createRouteMatcher(routeTree): RouteMatcher;
-```
-
-Defined in: [create-route-matcher.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-matcher.ts#L74)
-
-Create a URL pattern matcher 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, a `URLPatternUnavailableError` is thrown.
-Static (exact) routes are unaffected by URLPattern availability.
-
-Usage:
-
-```typescript
-const routeTree = extractMachineRoutes(machine);
-const routeMatcher = createRouteMatcher(routeTree);
-
-const { to, params } = routeMatcher.match("/settings/account");
-if (to) {
-	actor.send({ type: "play.route", to, params });
-}
-```
-
-## Parameters
-
-| Parameter   | Type                                      |
-| ----------- | ----------------------------------------- |
-| `routeTree` | [`RouteTree`](../interfaces/RouteTree.md) |
-
-## Returns
-
-[`RouteMatcher`](../interfaces/RouteMatcher.md)

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

@@ -1,56 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatcher
-
-# Interface: RouteMatcher
-
-Defined in: [create-route-matcher.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-matcher.ts#L20)
-
-URL route matcher interface returned by `createRouteMatcher()`.
-
-Matches incoming URL paths to state IDs (with `#` prefix) and extracts
-route parameters. Used by `RouterBridgeBase` to translate router navigation
-events into `play.route` actor events.
-
-## See
-
-- [createRouteMatcher](../functions/createRouteMatcher.md) for the factory function
-- [RouteMap](../classes/RouteMap.md) for direct state ID ↔ path lookups without params extraction
-
-## Methods
-
-### match()
-
-```ts
-match(path): object;
-```
-
-Defined in: [create-route-matcher.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-matcher.ts#L37)
-
-Match a URL path to a state ID and params.
-
-#### Parameters
-
-| Parameter | Type     | Description                              |
-| --------- | -------- | ---------------------------------------- |
-| `path`    | `string` | URL pathname (e.g., "/settings/account") |
-
-#### Returns
-
-`object`
-
-Object with `to` (state ID with # prefix) and `params`
-
-Example:
-
-```typescript
-const { to, params } = routeMatcher.match("/settings/account");
-// { to: "#settings", params: { section: "account" } }
-
-if (to) {
-	actor.send({ type: "play.route", to, params });
-}
-```
-
-| Name     | Type                           | Defined in                                                                                                                                          |
-| -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `params` | `Record`\<`string`, `string`\> | [create-route-matcher.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-matcher.ts#L39) |
-| `to`     | `string` \| `null`             | [create-route-matcher.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-matcher.ts#L38) |

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

@@ -1,33 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayRouterProvider
-
-# Function: PlayRouterProvider()
-
-```ts
-function PlayRouterProvider<TActor>(props): any;
-```
-
-Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L31)
-
-Connects a `PlayerActor` to TanStack Solid Router, keeping actor state and
-browser URL in sync bidirectionally.
-
-The bridge is created synchronously at component evaluation time (Solid's
-execution model) and torn down via `onCleanup` when the component is disposed.
-Unlike React, prop stability is not a concern — Solid's `props` accessor is
-already reactive and the bridge is created once per component instance.
-
-## Type Parameters
-
-| Type Parameter                                               |
-| ------------------------------------------------------------ |
-| `TActor` _extends_ [`PlayActor`](../interfaces/PlayActor.md) |
-
-## Parameters
-
-| Parameter | Type                                                                              |
-| --------- | --------------------------------------------------------------------------------- |
-| `props`   | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md)\<`TActor`\> |
-
-## Returns
-
-`any`