@xmachines/docs 2.2.0 → 4.0.0

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/v2.2.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/v2.2.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/v2.2.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/v2.2.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/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-react-router/interfaces/PlayActor.md

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-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-router/functions/createRouteMap.md

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [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-router/functions/getNavigableRoutes.md

@@ -1,35 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getNavigableRoutes
-
-# Function: getNavigableRoutes()
-
-```ts
-function getNavigableRoutes(tree, stateId): RouteNode[];
-```
-
-Defined in: [query.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/query.ts#L48)
-
-Returns every route of a navigation from the given state
-
-The function returns the child routes of the state. A later version also returns
-the sibling routes of a transition.
-
-## Parameters
-
-| Parameter | Type                                      | Description                                 |
-| --------- | ----------------------------------------- | ------------------------------------------- |
-| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | The route tree, from extractMachineRoutes() |
-| `stateId` | `string`                                  | The ID of the current state                 |
-
-## Returns
-
-[`RouteNode`](../interfaces/RouteNode.md)[]
-
-The array of the route nodes that the state can reach
-
-## Example
-
-```typescript
-const tree = extractMachineRoutes(machine);
-const routes = getNavigableRoutes(tree, "dashboard");
-// [{ id: 'overview', path: '/overview', ... }, { id: 'settings', ... }]
-```

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

@@ -1,24 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getPatternParamNames
-
-# Function: getPatternParamNames()
-
-```ts
-function getPatternParamNames(pattern): string[];
-```
-
-Defined in: [framework-params.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/framework-params.ts#L27)
-
-Reads the names of every `:param` of a route pattern of the route map.
-
-## Parameters
-
-| Parameter | Type     | Description                                      |
-| --------- | -------- | ------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId`. |
-
-## Returns
-
-`string`[]
-
-The names, in the order that the pattern declares them. A fresh array, because
-`readPatternParams` caches the one it holds.

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

@@ -1,36 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getRequiredPatternParamNames
-
-# Function: getRequiredPatternParamNames()
-
-```ts
-function getRequiredPatternParamNames(pattern): string[];
-```
-
-Defined in: [framework-params.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/framework-params.ts#L85)
-
-The names of every param the pattern REQUIRES, so `:name?` is left out.
-
-An optional segment that did not match has no value, and a framework reports none.
-That is a complete answer and not a partial one, so a MIXED pattern such as
-`/profile/:userId/:tab?` keeps the parse of the framework when only `:tab` is absent.
-A caller that counted that absence as a gap would fall back to the URLPattern
-extraction, which THROWS on a runtime with no URLPattern — for a route the framework
-had already answered.
-
-A pattern whose params are ALL optional reports nothing at all, which reads the same
-as "the framework matched another route", so [pickOwnParams](pickOwnParams.md) falls back for it.
-[resolveFrameworkParams](resolveFrameworkParams.md) settles that case from the PATH instead, and it needs
-no URLPattern to do it.
-
-## Parameters
-
-| Parameter | Type     | Description                                            |
-| --------- | -------- | ------------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId/:tab?`. |
-
-## Returns
-
-`string`[]
-
-The required names, in the order that the pattern declares them. A fresh
-array, because `readPatternParams` caches the one it holds.

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

@@ -1,26 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
-
-# Function: routeExists()
-
-```ts
-function routeExists(tree, path): boolean;
-```
-
-Defined in: [query.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/query.ts#L135)
-
-Tells you if a route path is in the tree
-
-The function tests if the path has a state with a `meta.route` field.
-
-## Parameters
-
-| Parameter | Type                                      | Description                                                |
-| --------- | ----------------------------------------- | ---------------------------------------------------------- |
-| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | The route tree, from extractMachineRoutes()                |
-| `path`    | `string`                                  | The complete route path, for example '/dashboard/settings' |
-
-## Returns
-
-`boolean`
-
-true when the tree holds the path. In every other case, false

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

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
-
-# Interface: BuildPlayRouteEventOptions
-
-Defined in: [router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-sync.ts#L17)
-
-## Properties
-
-| Property                                  | Type                                                   | Defined in                                                                                                                |
-| ----------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [router-sync.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-sync.ts#L20) |
-| <a id="property-pathname"></a> `pathname` | `string`                                               | [router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-sync.ts#L18) |
-| <a id="property-search"></a> `search?`    | `string`                                               | [router-sync.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/router-sync.ts#L19) |

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

@@ -1,15 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
-
-# Interface: MachineEdgeData
-
-Defined in: [types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L25)
-
-The data on each edge of the graph that represents the machine.
-It holds the event of the transition and the information of its guard.
-
-## Properties
-
-| Property                                         | Type     | Description                                                                                      | Defined in                                                                                                    |
-| ------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
-| <a id="property-eventtype"></a> `eventType`      | `string` | The event type that starts this transition                                                       | [types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L27) |
-| <a id="property-guardtype"></a> ~~`guardType?`~~ | `string` | The guard as a string, when a guard is present **Deprecated** Will be removed in the next major. | [types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L33) |

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

@@ -1,17 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
-
-# Interface: MachineNodeData
-
-Defined in: [types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L10)
-
-The data on each node of the graph that represents the machine.
-It holds the state metadata that the route extraction and the queries need.
-
-## Properties
-
-| Property                                | Type                                                                   | Description                                                | Defined in                                                                                                    |
-| --------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| <a id="property-meta"></a> `meta?`      | `Record`\<`string`, `unknown`\>                                        | The original meta object of the state                      | [types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L16) |
-| <a id="property-route"></a> `route?`    | `string`                                                               | The route path of meta.route, in its string form           | [types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L18) |
-| <a id="property-stateid"></a> `stateId` | `string`                                                               | The XState state ID, for example "test.dashboard.overview" | [types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L12) |
-| <a id="property-type"></a> `type`       | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | The state type of XState                                   | [types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L14) |

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

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [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`](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`](RoutableActor.md).[`currentRoute`](RoutableActor.md#property-currentroute) | [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.                                                                                                                                                 | -                                                                                            | [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`](RoutableActor.md).[`initialRoute`](RoutableActor.md#property-initialroute) | [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: [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`](RoutableActor.md).[`send`](RoutableActor.md#send)