@xmachines/docs 2.2.0 → 4.0.0

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

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [play-router/src/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L313)
-
-The complete actor shape of the `PlayRouterProvider` component of each framework
-adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
-adapter on the shared framework router bridge bases.
-
-The shape extends `RoutableActor` with `currentView`, because the provider renders
-the current view spec and also keeps the routes in step. It therefore needs both
-capabilities.
-
-- Use `RoutableActor` when you need the routing alone, for example in a
-  `RouterBridgeBase` subclass, or in `connectRouter`.
-- Use `PlayActor` when the component also renders the current view spec, for
-  example for the renderer callback parameter of `PlayRouterProvider`, and in
-  `PlayRenderer`.
-
-Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
-satisfies this interface structurally.
-
-## Example
-
-```typescript
-import type { PlayActor } from "@xmachines/play-router";
-
-function MyRouterProvider({ actor }: { actor: PlayActor }) {
-	// it reads actor.currentRoute for the routing, and actor.currentView for the render
-}
-```
-
-## Extends
-
-- [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                              | Inherited from                                                                                                                                                 | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active.                                                                                                                                                 | -                                                                                                                                                              | [play-router/src/types.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L315) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`send`](../../play-dom-router/interfaces/RoutableActor.md#send)

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

@@ -1,31 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / RouteNavigateEvent
-
-# ~~Interface: RouteNavigateEvent~~
-
-Defined in: [play-tanstack-react-router/src/types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-tanstack-react-router/src/types.ts#L24)
-
-The event that the bridge sends to the actor when the browser navigates.
-
-A browser navigation sends this event to the actor. A click on a link, the BACK
-or FORWARD button, and a URL that the user types each cause a navigation. The
-guards of the actor then decide if the business logic permits the navigation.
-
-Invariant: Passive Infrastructure. The router makes a request, and the actor
-decides the validity.
-
-## Example
-
-```typescript
-actor.send({ type: "route.navigate", path: "/dashboard" });
-```
-
-## Deprecated
-
-Superseded by `PlayRouteEvent` from `@xmachines/play-router`. Will be removed in the next major.
-
-## Properties
-
-| Property                              | Modifier   | Type               | Description                                                            | Defined in                                                                                                                                                  |
-| ------------------------------------- | ---------- | ------------------ | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> ~~`path`~~ | `readonly` | `string`           | The target route path. It can hold a parameter, for example /posts/123 | [play-tanstack-react-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-tanstack-react-router/src/types.ts#L28) |
-| <a id="property-type"></a> ~~`type`~~ | `readonly` | `"route.navigate"` | The event type discriminant. It follows the XState event pattern       | [play-tanstack-react-router/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-tanstack-react-router/src/types.ts#L26) |

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-solid-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/v2.2.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 });
-```

package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [play-router/src/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L313)
-
-The complete actor shape of the `PlayRouterProvider` component of each framework
-adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
-adapter on the shared framework router bridge bases.
-
-The shape extends `RoutableActor` with `currentView`, because the provider renders
-the current view spec and also keeps the routes in step. It therefore needs both
-capabilities.
-
-- Use `RoutableActor` when you need the routing alone, for example in a
-  `RouterBridgeBase` subclass, or in `connectRouter`.
-- Use `PlayActor` when the component also renders the current view spec, for
-  example for the renderer callback parameter of `PlayRouterProvider`, and in
-  `PlayRenderer`.
-
-Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
-satisfies this interface structurally.
-
-## Example
-
-```typescript
-import type { PlayActor } from "@xmachines/play-router";
-
-function MyRouterProvider({ actor }: { actor: PlayActor }) {
-	// it reads actor.currentRoute for the routing, and actor.currentView for the render
-}
-```
-
-## Extends
-
-- [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                              | Inherited from                                                                                                                                                 | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active.                                                                                                                                                 | -                                                                                                                                                              | [play-router/src/types.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L315) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`send`](../../play-dom-router/interfaces/RoutableActor.md#send)

package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / RoutableActor
-
-# ~~Type Alias: RoutableActor~~
-
-```ts
-type RoutableActor = PlayActor;
-```
-
-Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)
-
-## Deprecated
-
-Use `PlayActor` from `@xmachines/play-router`. The next major version removes this alias.

package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue](../README.md) / VisibilityProviderProps
-
-# ~~Interface: VisibilityProviderProps~~
-
-Defined in: [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-vue/src/types.ts#L27)
-
-## Deprecated
-
-Unused; will be removed in the next major.

package/api/@xmachines/play-vue/variables/getPlayViewContext.md

@@ -1,34 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue](../README.md) / getPlayViewContext
-
-# ~~Variable: getPlayViewContext~~
-
-```ts
-const getPlayViewContext: () => ViewContextValue = usePlayView;
-```
-
-Defined in: [packages/play-vue/src/actor-provider-context.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-vue/src/actor-provider-context.ts#L55)
-
-Access the current ViewContextValue from inside an ActorProvider tree.
-
-Returns the current ViewContextValue inside an ActorProvider tree.
-
-## Returns
-
-[`ViewContextValue`](../interfaces/ViewContextValue.md)
-
-## Throws
-
-When the caller is outside an <ActorProvider> tree or a <PlayUIProvider> tree
-
-## Example
-
-```typescript
-import { usePlayView } from "@xmachines/play-vue";
-
-const view = usePlayView();
-// view.spec, view.handlers, view.registry
-```
-
-## Deprecated
-
-Renamed to [usePlayView](../functions/usePlayView.md); will be removed in the next major.

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-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/v2.2.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 });
-```

package/api/@xmachines/play-vue-router/interfaces/PlayActor.md

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [play-router/src/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L313)
-
-The complete actor shape of the `PlayRouterProvider` component of each framework
-adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
-adapter on the shared framework router bridge bases.
-
-The shape extends `RoutableActor` with `currentView`, because the provider renders
-the current view spec and also keeps the routes in step. It therefore needs both
-capabilities.
-
-- Use `RoutableActor` when you need the routing alone, for example in a
-  `RouterBridgeBase` subclass, or in `connectRouter`.
-- Use `PlayActor` when the component also renders the current view spec, for
-  example for the renderer callback parameter of `PlayRouterProvider`, and in
-  `PlayRenderer`.
-
-Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
-satisfies this interface structurally.
-
-## Example
-
-```typescript
-import type { PlayActor } from "@xmachines/play-router";
-
-function MyRouterProvider({ actor }: { actor: PlayActor }) {
-	// it reads actor.currentRoute for the routing, and actor.currentView for the render
-}
-```
-
-## Extends
-
-- [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                              | Inherited from                                                                                                                                                 | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active.                                                                                                                                                 | -                                                                                                                                                              | [play-router/src/types.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L315) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`send`](../../play-dom-router/interfaces/RoutableActor.md#send)

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

@@ -1,135 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / PlayRouteEvent
-
-# Interface: PlayRouteEvent
-
-Defined in: [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L238)
-
-The routing event, with its parameters and its query
-
-This is the one routing event of the complete Play architecture. It supports a
-navigation that knows the parameters, for example `/profile/:userId`, for a dynamic
-route segment.
-
-**Architectural context:** the event implements **Passive Infrastructure
-(INV-04)**, because it holds the navigation intent of the user, and the Actor then
-evaluates that intent with its guards. The infrastructure makes a request with a
-`play.route` event, and the Actor decides with a transition of its state machine.
-
-**The flow of a browser navigation:**
-
-1. The browser fires `popstate`
-2. The router adapter resolves the URL to a route target
-3. The adapter sends a `PlayRouteEvent` to the Actor
-4. The Actor checks the transition with the guards of its state machine
-
-## Param
-
-**type**
-
-The discriminator of the event. It is always "play.route"
-
-## Param
-
-**to**
-
-The target state ID, with a # prefix, for example '#home' or '#profile'
-
-## Param
-
-**params**
-
-The route parameters of the path only, from the URL path, for
-example `{ userId: '123' }` of `/profile/123`. The `query` field holds the query
-parameters separately.
-
-## Param
-
-**query**
-
-The query parameters only. They stay separate from the params of the path
-
-## Param
-
-**match**
-
-The complete match result of URLPattern, for the debug work and for
-the observability. It is optional
-
-## Examples
-
-The base event and the routing event together
-
-```typescript
-import type { PlayEvent } from "@xmachines/play";
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-type AppEvent = PlayEvent | PlayRouteEvent;
-```
-
-A basic navigation to a route
-
-```typescript
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const event: PlayRouteEvent = {
-	type: "play.route",
-	to: "#home",
-};
-actor.send(event);
-```
-
-A 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);
-// It resolves to the route /profile/123
-```
-
-A navigation with query parameters
-
-```typescript
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const event: PlayRouteEvent = {
-	type: "play.route",
-	to: "#settings",
-	params: { section: "profile" }, // a route parameter of the path only
-	query: { tab: "security" }, // the query only
-};
-actor.send(event);
-// It resolves to the route /settings/profile?tab=security
-```
-
-## See
-
-[Play RFC](../../../../rfc/play.md)
-
-## Remarks
-
-Use `play.route` when you need a navigation that knows the parameters, with the
-`route: {}` config pattern on the nodes of your state machine. The `match` field
-gives you the complete URLPatternResult, for an advanced use such as a debug or an
-analysis of the pattern.
-
-## Indexable
-
-```ts
-[key: string]: unknown
-```
-
-## Properties
-
-| Property                               | Modifier   | Type                           | Defined in                                                                                                                      |
-| -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:243](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L243) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L241) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L242) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L240) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L239) |

package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RoutableActor
-
-# ~~Type Alias: RoutableActor~~
-
-```ts
-type RoutableActor = PlayActor;
-```
-
-Defined in: [play-vue-router/src/play-router-provider.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-vue-router/src/play-router-provider.ts#L11)
-
-## Deprecated
-
-Use `PlayActor` from `@xmachines/play-router`. The next major version removes this alias.

package/api/@xmachines/play-vue-router/type-aliases/VueRouteMap.md

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueRouteMap
-
-# ~~Type Alias: VueRouteMap~~
-
-```ts
-type VueRouteMap = RouteMap;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-vue-router/src/vue-base-route-map.ts#L8)
-
-## Deprecated
-
-Use `RouteMap` from `@xmachines/play-router`. Will be removed in the next major.

package/api/@xmachines/play-vue-router/variables/VueRouteMap.md

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueRouteMap
-
-# ~~Variable: VueRouteMap~~
-
-```ts
-const VueRouteMap: typeof RouteMap = RouteMap;
-```
-
-Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-vue-router/src/vue-base-route-map.ts#L8)
-
-## Deprecated
-
-Use `RouteMap` from `@xmachines/play-router`. Will be removed in the next major.