@xmachines/docs 3.0.0 → 4.0.0

package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md

@@ -1,48 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / BaseActorProviderProps
-
-# Interface: BaseActorProviderProps\<TRegistry\>
-
-Defined in: [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L159)
-
-The framework-agnostic base props. Every `ActorProvider` implementation shares
-them: React, Vue, Solid, and Svelte. `TRegistry` holds the
-`DefineRegistryResult` type of the framework. `RenderErrorHandler` comes from
-`@xmachines/json-render-core`, and a second generic parameter is therefore not
-necessary.
-
-Each framework package extends this interface with its `fallback` field, its
-`onError` field, and its `children` field.
-
-## Example
-
-```ts
-import type { BaseActorProviderProps } from "@xmachines/play-actor";
-import type { DefineRegistryResult } from "@xmachines/json-render-react";
-
-interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
-	fallback?: React.ReactNode;
-	children: React.ReactNode;
-}
-```
-
-## Extended by
-
-- [`ActorProviderProps`](../../play-react/interfaces/ActorProviderProps.md)
-- [`ActorProviderProps`](../../play-solid/interfaces/ActorProviderProps.md)
-- [`ActorProviderProps`](../../play-svelte/interfaces/ActorProviderProps.md)
-- [`ActorProviderProps`](../../play-vue/interfaces/ActorProviderProps.md)
-
-## Type Parameters
-
-| Type Parameter                 | Description                                       |
-| ------------------------------ | ------------------------------------------------- |
-| `TRegistry` _extends_ `object` | The `DefineRegistryResult` type of the framework. |
-
-## Properties
-
-| Property                                              | Type                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                       | Defined in                                                                                                                                               |
-| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L163) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md)                                                                                                                                              | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L177) |
-| <a id="property-registryresult"></a> `registryResult` | `TRegistry`                                                                                                                                                                                                            | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L165) |
-| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                           | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L172) |

package/api/@xmachines/play-actor/interfaces/Routable.md

@@ -1,14 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / Routable
-
-# Interface: Routable
-
-Defined in: [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L33)
-
-An optional capability: the routing support
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                         | Defined in                                                                                                                                             |
-| ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L34) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | [packages/play-actor/src/abstract-actor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-actor/src/abstract-actor.ts#L35) |

package/api/@xmachines/play-dom/type-aliases/DisposablePlayUI.md

@@ -1,36 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom](../README.md) / DisposablePlayUI
-
-# Type Alias: DisposablePlayUI
-
-```ts
-type DisposablePlayUI = (...args) => Cleanup;
-```
-
-Defined in: [packages/play-dom/src/create-play-ui.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom/src/create-play-ui.ts#L102)
-
-The mount function that [createPlayUI](../functions/createPlayUI.md) builds.
-
-It IS a [MountFn](MountFn.md), and it says one thing more: the mount hands back a
-[Cleanup](Cleanup.md), so a caller may release it with `using` and write no teardown.
-
-```ts
-const mount = createPlayUI(registryResult);
-{
-	using stop = mount(actor, container);
-	// stop() runs at the end of the scope, and after an exception too
-}
-```
-
-A narrowed return and not a narrowed `MountFn`: the return type of a function may
-narrow, so this costs a consumer that writes a `MountFn` nothing. The parameters come
-from `MountFn` through `Parameters`, so the two signatures cannot drift.
-
-## Parameters
-
-| Parameter | Type                                    |
-| --------- | --------------------------------------- |
-| ...`args` | `Parameters`\<[`MountFn`](MountFn.md)\> |
-
-## Returns
-
-[`Cleanup`](Cleanup.md)

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
-
-Creates a `RouteMap` from an XState state machine.
-
-The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
-stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
-converts each change of the browser URL into a `play.route` actor event, and each
-actor route into a URL.
-
-## Parameters
-
-| Parameter  | Type                                                                      | Description                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
-
-## Returns
-
-[`RouteMap`](../interfaces/RouteMap.md)
-
-A `RouteMap` for each adapter on `RouterBridgeBase`.
-
-## Example
-
-```typescript
-import { createRouteMap } from "@xmachines/play-router";
-import { connectRouter } from "@xmachines/play-dom-router";
-
-const routeMap = createRouteMap(myMachine);
-const disconnect = connectRouter({ actor, router, routeMap });
-```

package/api/@xmachines/play-dom-router/interfaces/DisposableBrowserHistory.md

@@ -1,262 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / DisposableBrowserHistory
-
-# Interface: DisposableBrowserHistory
-
-Defined in: [play-dom-router/src/create-browser-history.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L87)
-
-The history that [createBrowserHistory](../functions/createBrowserHistory.md) builds.
-
-It IS a [BrowserHistory](BrowserHistory.md), and it says one thing more: `subscribe` hands back a
-[Cleanup](../type-aliases/Cleanup.md), so a caller may release it with `using` and write no teardown.
-
-```ts
-const history = createBrowserHistory({ window });
-{
-	using stop = history.subscribe((location) => render(location));
-	// stop() runs at the end of the scope, and after an exception too
-}
-```
-
-The history itself is a `Disposable` too, and [BrowserHistory.destroy](BrowserHistory.md#destroy) is what it
-releases. `destroy()` unpatches `history.pushState` and `history.replaceState` of the
-window, so a scope that drops the history without it leaves the global patched:
-
-```ts
-{
-	using history = createBrowserHistory({ window });
-	history.push("/first");
-	// destroy() runs at the end of the scope, and after an exception too
-}
-```
-
-A narrowed return and not a narrowed interface: the return type of a method may narrow
-in an extension, so this costs an implementer of `BrowserHistory` nothing. The dispose
-key is added here, and not on `BrowserHistory`, for the same reason.
-
-## Extends
-
-- [`BrowserHistory`](BrowserHistory.md)
-
-## Properties
-
-| Property                                  | Modifier   | Type      | Description                               | Inherited from                                                                          | Defined in                                                                                                                                                              |
-| ----------------------------------------- | ---------- | --------- | ----------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-location"></a> `location` | `readonly` | `object`  | Returns the state of the current location | [`BrowserHistory`](BrowserHistory.md).[`location`](BrowserHistory.md#property-location) | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L7)   |
-| `location.hash`                           | `public`   | `string`  | -                                         | -                                                                                       | [play-dom-router/src/create-browser-history.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L10) |
-| `location.pathname`                       | `public`   | `string`  | -                                         | -                                                                                       | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L8)   |
-| `location.search`                         | `public`   | `string`  | -                                         | -                                                                                       | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L9)   |
-| `location.state`                          | `public`   | `unknown` | -                                         | -                                                                                       | [play-dom-router/src/create-browser-history.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L11) |
-
-## Methods
-
-### \[dispose\]()
-
-```ts
-dispose: void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L91)
-
-Releases the history with [BrowserHistory.destroy](BrowserHistory.md#destroy). It is idempotent.
-
-#### Returns
-
-`void`
-
----
-
-### back()
-
-```ts
-back(): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L28)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`back`](BrowserHistory.md#back)
-
----
-
-### createHref()
-
-```ts
-createHref(path): string;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L46)
-
-Creates an href from a path
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`createHref`](BrowserHistory.md#createhref)
-
----
-
-### destroy()
-
-```ts
-destroy(): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L54)
-
-Cleans up.
-
-A second call is safe. When more than one wrapper shares the same
-`window.history`, the last wrapper restores the original methods.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`destroy`](BrowserHistory.md#destroy)
-
----
-
-### forward()
-
-```ts
-forward(): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L29)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`forward`](BrowserHistory.md#forward)
-
----
-
-### go()
-
-```ts
-go(delta): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L27)
-
-Moves back or forward in the history
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `delta`   | `number` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`go`](BrowserHistory.md#go)
-
----
-
-### push()
-
-```ts
-push(path, state?): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L17)
-
-Pushes a new URL to the history
-
-#### Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `path`    | `string`  |
-| `state?`  | `unknown` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`push`](BrowserHistory.md#push)
-
----
-
-### replace()
-
-```ts
-replace(path, state?): void;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L22)
-
-Replaces the current URL in the history
-
-#### Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `path`    | `string`  |
-| `state?`  | `unknown` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BrowserHistory`](BrowserHistory.md).[`replace`](BrowserHistory.md#replace)
-
----
-
-### subscribe()
-
-```ts
-subscribe(...args): Cleanup;
-```
-
-Defined in: [play-dom-router/src/create-browser-history.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-browser-history.ts#L88)
-
-Subscribes to the history changes.
-It returns a function that cancels the subscription.
-
-The return is a plain function here, because a consumer IMPLEMENTS this interface
-to inject its own history for a test or for SSR. A `Cleanup` return would refuse
-every implementation that hands a plain function back.
-DisposableBrowserHistory narrows it for the value that
-[createBrowserHistory](../functions/createBrowserHistory.md) builds, which nothing implements.
-
-#### Parameters
-
-| Parameter | Type                       |
-| --------- | -------------------------- |
-| ...`args` | \[(`location`) => `void`\] |
-
-#### Returns
-
-[`Cleanup`](../type-aliases/Cleanup.md)
-
-#### Overrides
-
-[`BrowserHistory`](BrowserHistory.md).[`subscribe`](BrowserHistory.md#subscribe)

package/api/@xmachines/play-dom-router/interfaces/DisposableVanillaRouter.md

@@ -1,80 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / DisposableVanillaRouter
-
-# Interface: DisposableVanillaRouter\<History\>
-
-Defined in: [play-dom-router/src/create-router.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-router.ts#L59)
-
-The router that [createRouter](../functions/createRouter.md) returns: a [VanillaRouter](VanillaRouter.md) that a `using`
-scope can hold.
-
-The router OWNS the history, and the history patches `window.history.pushState`. It was
-the one release of this package that a scope could not hold: the history, a
-subscription of it, and the connection of the router each carry the protocol, and the
-router itself carried none, so a scope that forgot `destroy()` left the global patched.
-
-The release covers the HISTORY alone, exactly as `destroy()` always did. `connectRouter`
-hands back its own `RouterConnection`, and a scope that ends releases no connection for
-the caller: release the connection first, then the router.
-
-```ts
-using router = createRouter({ routeTree, history });
-```
-
-The key sits on THIS type and not on [VanillaRouter](VanillaRouter.md), exactly as
-`DisposableBrowserHistory` sits beside `BrowserHistory`: a caller that builds a router
-of its own — a test double, or a router of another history — keeps a type that asks for
-no dispose key.
-
-A caller that keeps `destroy()` keeps it: the two release the same work, and the
-release is idempotent because `BrowserHistory.destroy` is.
-
-## Extends
-
-- [`VanillaRouter`](VanillaRouter.md)\<`History`\>
-
-## Type Parameters
-
-| Type Parameter                                            | Default type                          |
-| --------------------------------------------------------- | ------------------------------------- |
-| `History` _extends_ [`BrowserHistory`](BrowserHistory.md) | [`BrowserHistory`](BrowserHistory.md) |
-
-## Properties
-
-| Property                                    | Modifier   | Type                                                     | Description                                     | Inherited from                                                                         | Defined in                                                                                                                                            |
-| ------------------------------------------- | ---------- | -------------------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`     | `readonly` | `History`                                                | The history instance                            | [`VanillaRouter`](VanillaRouter.md).[`history`](VanillaRouter.md#property-history)     | [play-dom-router/src/create-router.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-router.ts#L21) |
-| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [`VanillaRouter`](VanillaRouter.md).[`routeTree`](VanillaRouter.md#property-routetree) | [play-dom-router/src/create-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-router.ts#L26) |
-
-## Methods
-
-### \[dispose\]()
-
-```ts
-dispose: void;
-```
-
-Defined in: [play-dom-router/src/create-router.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-router.ts#L62)
-
-#### Returns
-
-`void`
-
----
-
-### destroy()
-
-```ts
-destroy(): void;
-```
-
-Defined in: [play-dom-router/src/create-router.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-dom-router/src/create-router.ts#L31)
-
-Cleans up
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`VanillaRouter`](VanillaRouter.md).[`destroy`](VanillaRouter.md#destroy)

package/api/@xmachines/play-dom-router/interfaces/RouteMap.md

@@ -1,122 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMap
-
-# Interface: RouteMap
-
-Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-route-map.ts#L105)
-
-The shared base class of the route map for both directions.
-
-Every framework adapter uses this class as its route map. An adapter adds no logic
-of its own, and it inherits the complete public API from here.
-
-**The strategy of a lookup:**
-
-- A static path, without a `:param` → a `Map` lookup in O(1)
-- A dynamic path → a scan of the bucket index in O(k), with `URLPattern`, where
-  `k` is the number of the routes with the same first path segment
-- The class keeps each result of a first match in an LRU cache. The default size
-  is 500 entries, and the `cacheSize` constructor option changes it
-
-**The syntax of a pattern** (`:param`, `:param?`, and `*`):
-
-- `:param` — a necessary segment. It matches exactly one segment without a `/`
-- `:param?` — an optional segment. It matches zero segments or one segment without a `/`
-- `*` — a wildcard. It matches each number of segments, as URLPattern defines
-
-**The forms of a stateId:** you can register a stateId, and you can look one up,
-in the form `"#stateId"` or in the form `"stateId"`. `RouteMap` makes the
-canonical form itself. `getStateIdByPath` returns the stateId exactly as you
-registered it, and `getPathByStateId` accepts both forms. A registration of the
-same stateId in both forms gives one entry, and the later registration wins for
-the lookup in the other direction.
-
-## Example
-
-```typescript
-import { RouteMap } from "@xmachines/play-router";
-
-const map = new RouteMap([
-	{ stateId: "home", path: "/" },
-	{ stateId: "profile", path: "/profile/:userId" },
-	{ stateId: "settings", path: "/settings/:section?" },
-]);
-
-map.getStateIdByPath("/"); // "home"
-map.getStateIdByPath("/profile/123"); // "profile"
-map.getStateIdByPath("/settings"); // "settings"
-map.getStateIdByPath("/unknown"); // null
-
-map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("missing"); // null
-```
-
-## Methods
-
-### getPathByStateId()
-
-```ts
-getPathByStateId(stateId): string | null;
-```
-
-Defined in: [play-router/src/base-route-map.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-route-map.ts#L229)
-
-Returns the path pattern of a state ID.
-
-The method accepts the stateId in the form `"#stateId"` and in the form
-`"stateId"`, and the form of the registration has no effect. The method makes the
-canonical form itself. Therefore a consumer tries never both forms.
-
-#### Parameters
-
-| Parameter | Type     | Description                                                                 |
-| --------- | -------- | --------------------------------------------------------------------------- |
-| `stateId` | `string` | The state ID of the state machine, for example `"profile"` or `"#settings"` |
-
-#### Returns
-
-`string` \| `null`
-
-The registered path pattern, or `null` when the state ID is unknown
-
-#### Example
-
-```typescript
-map.getPathByStateId("profile"); // "/profile/:userId"
-map.getPathByStateId("#profile"); // "/profile/:userId" — the same entry
-map.getPathByStateId("missing"); // null
-```
-
----
-
-### getStateIdByPath()
-
-```ts
-getStateIdByPath(path): string | null;
-```
-
-Defined in: [play-router/src/base-route-map.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-route-map.ts#L189)
-
-Resolves a URL path to its state ID.
-
-The method removes the query string and the hash fragment before the match. It
-tries an exact lookup in O(1) first, then it uses the pattern match on the bucket
-index. It keeps each result of a first pattern match in the cache.
-
-#### Parameters
-
-| Parameter | Type     | Description                                                                            |
-| --------- | -------- | -------------------------------------------------------------------------------------- |
-| `path`    | `string` | The URL pathname. It can hold a query and a hash, for example `"/profile/123?ref=nav"` |
-
-#### Returns
-
-`string` \| `null`
-
-The state ID of the path, or `null` when no route matches
-
-#### Example
-
-```typescript
-map.getStateIdByPath("/profile/123"); // "profile"
-map.getStateIdByPath("/unknown"); // null
-```

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

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-react](../README.md) / PlayRendererProps
-
-# ~~Type Alias: PlayRendererProps~~
-
-```ts
-type PlayRendererProps = ActorProviderProps;
-```
-
-Defined in: [packages/play-react/src/index.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-react/src/index.ts#L71)
-
-## Deprecated
-
-Use [ActorProviderProps](../interfaces/ActorProviderProps.md). Will be removed in the next major.

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
-
-Creates a `RouteMap` from an XState state machine.
-
-The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
-stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
-converts each change of the browser URL into a `play.route` actor event, and each
-actor route into a URL.
-
-## Parameters
-
-| Parameter  | Type                                                                      | Description                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
-
-## Returns
-
-[`RouteMap`](../classes/RouteMap.md)
-
-A `RouteMap` for each adapter on `RouterBridgeBase`.
-
-## Example
-
-```typescript
-import { createRouteMap } from "@xmachines/play-router";
-import { connectRouter } from "@xmachines/play-dom-router";
-
-const routeMap = createRouteMap(myMachine);
-const disconnect = connectRouter({ actor, router, routeMap });
-```