@xmachines/docs 7.0.0 → 7.2.0

package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md

@@ -2,7 +2,7 @@
 
 # Class: MissingStateIdError
 
-Defined in: [packages/play-xstate/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L135)
+Defined in: [packages/play-xstate/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/errors.ts#L135)
 
 `formatPlayRouteTransitions()` throws this error when a state node declares a
 `meta.route` field but no explicit `id` field.
@@ -47,7 +47,7 @@ states: {
 new MissingStateIdError(stateKey, route): MissingStateIdError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L141)
+Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/errors.ts#L141)
 
 #### Parameters
 
@@ -66,17 +66,17 @@ Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-
 
 ## Properties
 
-| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                                 |
-| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/core/src/errors.ts#L56)                 |
-| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                          |
-| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                          |
-| <a id="property-route"></a> `route`                     | `readonly` | `string`  | The route template of the state, for example `"/profile/:username"`.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L139) |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/core/src/errors.ts#L46)                 |
-| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                          |
-| <a id="property-statekey"></a> `stateKey`               | `readonly` | `string`  | The state key, which is the position in the tree of the states, without an explicit `id` field.                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/errors.ts#L137) |
-| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                          |
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                                      |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                               |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/core/src/errors.ts#L56)                 |
+| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                               |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                               |
+| <a id="property-route"></a> `route`                     | `readonly` | `string`  | The route template of the state, for example `"/profile/:username"`.                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/errors.ts#L139) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/core/src/errors.ts#L46)                 |
+| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                               |
+| <a id="property-statekey"></a> `stateKey`               | `readonly` | `string`  | The state key, which is the position in the tree of the states, without an explicit `id` field.                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/errors.ts#L137) |
+| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                               |
 
 ## Methods
 

package/api/@xmachines/play-xstate/index/classes/PlayerActor.md

@@ -2,7 +2,7 @@
 
 # Class: PlayerActor\<TMachine\>
 
-Defined in: [packages/play-xstate/src/player-actor.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L144)
+Defined in: [packages/play-xstate/src/player-actor.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L144)
 
 The concrete XState actor. It implements the atom protocol of the Play Architecture
 
@@ -100,9 +100,9 @@ memoizes the result, so a repeated read computes no view again.
 
 ## Type Parameters
 
-| Type Parameter                                                                                 | Description                             |
-| ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| Type Parameter                                                                                                                      | Description                             |
+| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| <a id="type-parameter-tmachine"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
 
 ## Implements
 
@@ -121,7 +121,7 @@ new PlayerActor<TMachine>(
 ): PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L242)
+Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L242)
 
 #### Parameters
 
@@ -138,32 +138,30 @@ Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xm
 
 #### Overrides
 
-```ts
-Actor<TMachine>.constructor
-```
+`Actor<TMachine>.constructor`
 
 ## Properties
 
-| Property                                    | Modifier | Type                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                             | Inherited from    | Defined in                                                                                                                                             |
-| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-_parent"></a> `_parent?`    | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                       | `Actor._parent`   | -                                                                                                                                                      |
-| <a id="property-clock"></a> `clock`         | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                    | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                | `Actor.clock`     | -                                                                                                                                                      |
-| <a id="property-id"></a> `id`               | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The unique identifier for this actor relative to its parent.                                                                                                                                            | `Actor.id`        | -                                                                                                                                                      |
-| <a id="property-logic"></a> `logic`         | `public` | `TMachine`                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                       | `Actor.logic`     | -                                                                                                                                                      |
-| <a id="property-options"></a> `options`     | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                            | -                                                                                                                                                                                                       | `Actor.options`   | -                                                                                                                                                      |
-| <a id="property-ref"></a> `ref`             | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | -                                                                                                                                                                                                       | `Actor.ref`       | -                                                                                                                                                      |
-| <a id="property-sessionid"></a> `sessionId` | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The globally unique process ID for this invocation.                                                                                                                                                     | `Actor.sessionId` | -                                                                                                                                                      |
-| <a id="property-src"></a> `src`             | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                     | -                                                                                                                                                                                                       | `Actor.src`       | -                                                                                                                                                      |
-| <a id="property-state"></a> `state`         | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                                                                                                                                                                                                                          | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                 | [packages/play-xstate/src/player-actor.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L208) |
-| <a id="property-system"></a> `system`       | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                  | The system to which this actor belongs.                                                                                                                                                                 | `Actor.system`    | -                                                                                                                                                      |
-| <a id="property-systemid"></a> `systemId`   | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                       | `Actor.systemId`  | -                                                                                                                                                      |
+| Property                                    | Modifier | Type                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                             | Inherited from    | Defined in                                                                                                                                                  |
+| ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-_parent"></a> `_parent?`    | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                                                                                                                                                                                                        | -                                                                                                                                                                                                       | `Actor._parent`   | -                                                                                                                                                           |
+| <a id="property-clock"></a> `clock`         | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock)                                                                                                                                                                                                                                                                    | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions.                                                                                                | `Actor.clock`     | -                                                                                                                                                           |
+| <a id="property-id"></a> `id`               | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The unique identifier for this actor relative to its parent.                                                                                                                                            | `Actor.id`        | -                                                                                                                                                           |
+| <a id="property-logic"></a> `logic`         | `public` | `TMachine`                                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                       | `Actor.logic`     | -                                                                                                                                                           |
+| <a id="property-options"></a> `options`     | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                                                                                                                                                                                                            | -                                                                                                                                                                                                       | `Actor.options`   | -                                                                                                                                                           |
+| <a id="property-ref"></a> `ref`             | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | -                                                                                                                                                                                                       | `Actor.ref`       | -                                                                                                                                                           |
+| <a id="property-sessionid"></a> `sessionId` | `public` | `string`                                                                                                                                                                                                                                                                                                                 | The globally unique process ID for this invocation.                                                                                                                                                     | `Actor.sessionId` | -                                                                                                                                                           |
+| <a id="property-src"></a> `src`             | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                                                                                                                                                                                                     | -                                                                                                                                                                                                       | `Actor.src`       | -                                                                                                                                                           |
+| <a id="property-state"></a> `state`         | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                                                                                                                                                                                                                          | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | -                 | [packages/play-xstate/src/player-actor.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L208) |
+| <a id="property-system"></a> `system`       | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                                                                                                                                                                                                                  | The system to which this actor belongs.                                                                                                                                                                 | `Actor.system`    | -                                                                                                                                                           |
+| <a id="property-systemid"></a> `systemId`   | `public` | `string` \| `undefined`                                                                                                                                                                                                                                                                                                  | -                                                                                                                                                                                                       | `Actor.systemId`  | -                                                                                                                                                           |
 
 ## Methods
 
 ### \[observable\]()
 
 ```ts
-observable: InteropSubscribable<SnapshotFrom<TMachine>>;
+[observable](): InteropSubscribable<SnapshotFrom<TMachine>>;
 ```
 
 Defined in: `xstate`
@@ -174,9 +172,7 @@ Defined in: `xstate`
 
 #### Inherited from
 
-```ts
-Actor.[observable]
-```
+`Actor.[observable]`
 
 ---
 
@@ -186,7 +182,7 @@ Actor.[observable]
 can(event): boolean;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L221)
+Defined in: [packages/play-xstate/src/player-actor.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L221)
 
 Tells you if the current state of the actor accepts the given event.
 
@@ -217,7 +213,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
 getPersistedSnapshot(options?): Snapshot<unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L555)
+Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L555)
 
 Returns the persisted snapshot of this actor.
 
@@ -236,9 +232,7 @@ Use it to serialize the state, and to restore it later with the
 
 #### Overrides
 
-```ts
-Actor.getPersistedSnapshot;
-```
+`Actor.getPersistedSnapshot`
 
 ---
 
@@ -273,9 +267,7 @@ Note that some actors, such as callback actors generated with
 
 #### Inherited from
 
-```ts
-Actor.getSnapshot;
-```
+`Actor.getSnapshot`
 
 ---
 
@@ -289,9 +281,9 @@ Defined in: `xstate`
 
 #### Type Parameters
 
-| Type Parameter          |
-| ----------------------- |
-| `TType` _extends_ `any` |
+| Type Parameter                                            |
+| --------------------------------------------------------- |
+| <a id="type-parameter-ttype"></a> `TType` _extends_ `any` |
 
 #### Parameters
 
@@ -306,9 +298,7 @@ Defined in: `xstate`
 
 #### Inherited from
 
-```ts
-Actor.on;
-```
+`Actor.on`
 
 ---
 
@@ -322,9 +312,9 @@ Defined in: `xstate`
 
 #### Type Parameters
 
-| Type Parameter |
-| -------------- |
-| `TSelected`    |
+| Type Parameter                                    |
+| ------------------------------------------------- |
+| <a id="type-parameter-tselected"></a> `TSelected` |
 
 #### Parameters
 
@@ -339,9 +329,7 @@ Defined in: `xstate`
 
 #### Inherited from
 
-```ts
-Actor.select;
-```
+`Actor.select`
 
 ---
 
@@ -351,7 +339,7 @@ Actor.select;
 send(event): void;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L432)
+Defined in: [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L432)
 
 Sends an event to this actor.
 
@@ -391,9 +379,7 @@ actor.send({ type: "play.route", to: "#home" });
 
 #### Overrides
 
-```ts
-Actor.send;
-```
+`Actor.send`
 
 ---
 
@@ -403,7 +389,7 @@ Actor.send;
 start(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L358)
+Defined in: [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L358)
 
 Starts the actor.
 
@@ -419,9 +405,7 @@ the side effects of `onStart` one time for one real start.
 
 #### Overrides
 
-```ts
-Actor.start;
-```
+`Actor.start`
 
 ---
 
@@ -431,7 +415,7 @@ Actor.start;
 stop(): this;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:388](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L388)
+Defined in: [packages/play-xstate/src/player-actor.ts:388](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L388)
 
 Stops the actor and cleans up.
 
@@ -448,9 +432,7 @@ fires `onStart` again.
 
 #### Overrides
 
-```ts
-Actor.stop;
-```
+`Actor.stop`
 
 ---
 
@@ -462,7 +444,7 @@ Actor.stop;
 subscribe(observer): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L493)
+Defined in: [packages/play-xstate/src/player-actor.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L493)
 
 Subscribes to the snapshot updates of this actor.
 
@@ -482,9 +464,7 @@ The subscription, with an `unsubscribe()` method.
 
 ##### Overrides
 
-```ts
-Actor.subscribe;
-```
+`Actor.subscribe`
 
 #### Call Signature
 
@@ -496,7 +476,7 @@ subscribe(
 ): Subscription;
 ```
 
-Defined in: [packages/play-xstate/src/player-actor.ts:504](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/player-actor.ts#L504)
+Defined in: [packages/play-xstate/src/player-actor.ts:504](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/player-actor.ts#L504)
 
 Subscribes to the snapshot updates of this actor.
 
@@ -518,9 +498,7 @@ The subscription, with an `unsubscribe()` method.
 
 ##### Overrides
 
-```ts
-Actor.subscribe;
-```
+`Actor.subscribe`
 
 ---
 
@@ -543,6 +521,4 @@ Defined in: `xstate`
 
 #### Inherited from
 
-```ts
-Actor.toJSON;
-```
+`Actor.toJSON`

package/api/@xmachines/play-xstate/index/functions/compose.md

@@ -8,7 +8,7 @@
 function compose<TMachine>(Base): PlayerConstructor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/capabilities.ts#L103)
+Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/capabilities.ts#L103)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -23,9 +23,9 @@ TS2739. The overloads below are what carries `Routable` through.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 |
-| ---------------------------------------------------------------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| Type Parameter                                                                                                                      |
+| ----------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-tmachine"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
 
 ### Parameters
 
@@ -59,7 +59,7 @@ applies them from left to right.
 function compose<TMachine, TC1>(Base, c1): PlayerConstructor<TMachine, TC1>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/capabilities.ts#L106)
+Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/capabilities.ts#L106)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -74,10 +74,10 @@ TS2739. The overloads below are what carries `Routable` through.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 |
-| ---------------------------------------------------------------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
-| `TC1` _extends_ `object`                                                                       |
+| Type Parameter                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-tmachine-1"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| <a id="type-parameter-tc1"></a> `TC1` _extends_ `object`                                                                              |
 
 ### Parameters
 
@@ -112,7 +112,7 @@ applies them from left to right.
 function compose<TMachine, TC1, TC2>(Base, c1, c2): PlayerConstructor<TMachine, TC1 & TC2>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/capabilities.ts#L110)
+Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/capabilities.ts#L110)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -127,11 +127,11 @@ TS2739. The overloads below are what carries `Routable` through.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 |
-| ---------------------------------------------------------------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
-| `TC1` _extends_ `object`                                                                       |
-| `TC2` _extends_ `object`                                                                       |
+| Type Parameter                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-tmachine-2"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| <a id="type-parameter-tc1-1"></a> `TC1` _extends_ `object`                                                                            |
+| <a id="type-parameter-tc2"></a> `TC2` _extends_ `object`                                                                              |
 
 ### Parameters
 
@@ -172,7 +172,7 @@ function compose<TMachine, TC1, TC2, TC3>(
 ): PlayerConstructor<TMachine, TC1 & TC2 & TC3>;
 ```
 
-Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/capabilities.ts#L115)
+Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/capabilities.ts#L115)
 
 Builds an actor class from a base and a list of capabilities.
 
@@ -187,12 +187,12 @@ TS2739. The overloads below are what carries `Routable` through.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 |
-| ---------------------------------------------------------------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
-| `TC1` _extends_ `object`                                                                       |
-| `TC2` _extends_ `object`                                                                       |
-| `TC3` _extends_ `object`                                                                       |
+| Type Parameter                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-tmachine-3"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| <a id="type-parameter-tc1-2"></a> `TC1` _extends_ `object`                                                                            |
+| <a id="type-parameter-tc2-1"></a> `TC2` _extends_ `object`                                                                            |
+| <a id="type-parameter-tc3"></a> `TC3` _extends_ `object`                                                                              |
 
 ### Parameters
 

package/api/@xmachines/play-xstate/index/functions/definePlayer.md

@@ -8,7 +8,7 @@
 function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/define-player.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/define-player.ts#L62)
+Defined in: [packages/play-xstate/src/define-player.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/define-player.ts#L62)
 
 Creates a player factory from an XState machine
 
@@ -19,9 +19,9 @@ several instances, and with a render on the server.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 | Description                             |
-| ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| Type Parameter                                                                                                                      | Description                             |
+| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| <a id="type-parameter-tmachine"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
 
 ### Parameters
 
@@ -85,7 +85,7 @@ console.log(alice.state.get() !== bob.state.get());
 function definePlayer<TMachine, TCapabilities>(config): PlayerFactory<TMachine, TCapabilities>;
 ```
 
-Defined in: [packages/play-xstate/src/define-player.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/define-player.ts#L65)
+Defined in: [packages/play-xstate/src/define-player.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/define-player.ts#L65)
 
 Creates a player factory from an XState machine
 
@@ -96,10 +96,10 @@ several instances, and with a render on the server.
 
 ### Type Parameters
 
-| Type Parameter                                                                                 | Description                             |
-| ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
-| `TCapabilities` _extends_ `object`                                                             | -                                       |
+| Type Parameter                                                                                                                        | Description                             |
+| ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| <a id="type-parameter-tmachine-1"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
+| <a id="type-parameter-tcapabilities"></a> `TCapabilities` _extends_ `object`                                                          | -                                       |
 
 ### Parameters
 

package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md

@@ -2,21 +2,21 @@
 
 # Interface: PlayerConfig\<TMachine, TCapabilities\>
 
-Defined in: [packages/play-xstate/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L8)
+Defined in: [packages/play-xstate/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L8)
 
 The configuration of definePlayer()
 
 ## Type Parameters
 
-| Type Parameter                                                                                 | Default type |
-| ---------------------------------------------------------------------------------------------- | ------------ |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | -            |
-| `TCapabilities` _extends_ `object`                                                             | `object`     |
+| Type Parameter                                                                                                                      | Default type |
+| ----------------------------------------------------------------------------------------------------------------------------------- | ------------ |
+| <a id="type-parameter-tmachine"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | -            |
+| <a id="type-parameter-tcapabilities"></a> `TCapabilities` _extends_ `object`                                                        | `object`     |
 
 ## Properties
 
-| Property                                 | Type                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                        | Defined in                                                                                                                             |
-| ---------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor?`     | [`PlayerConstructor`](../type-aliases/PlayerConstructor.md)\<`TMachine`, `TCapabilities`\> | The actor class to build, which decides which CAPABILITIES the actor carries. `PlayerActor` is the default, and it holds `state` and `send` alone. Compose a class to add a capability, and the factory then answers an actor with it: `definePlayer({ machine, actor: compose(PlayerActor, withRouting, withView) });` An application that declares no route, and renders no view, passes nothing and loads neither body of code. | [packages/play-xstate/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L31) |
-| <a id="property-machine"></a> `machine`  | `TMachine`                                                                                 | The XState v5 state machine                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-xstate/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L13) |
-| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\>                                          | The lifecycle hooks and the configuration                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-xstate/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L16) |
+| Property                                 | Type                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                        | Defined in                                                                                                                                  |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor?`     | [`PlayerConstructor`](../type-aliases/PlayerConstructor.md)\<`TMachine`, `TCapabilities`\> | The actor class to build, which decides which CAPABILITIES the actor carries. `PlayerActor` is the default, and it holds `state` and `send` alone. Compose a class to add a capability, and the factory then answers an actor with it: `definePlayer({ machine, actor: compose(PlayerActor, withRouting, withView) });` An application that declares no route, and renders no view, passes nothing and loads neither body of code. | [packages/play-xstate/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L31) |
+| <a id="property-machine"></a> `machine`  | `TMachine`                                                                                 | The XState v5 state machine                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-xstate/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L13) |
+| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\>                                          | The lifecycle hooks and the configuration                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-xstate/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L16) |

package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: PlayerFactoryResumeOptions\<TMachine\>
 
-Defined in: [packages/play-xstate/src/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L134)
+Defined in: [packages/play-xstate/src/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L134)
 
 The optional restore arguments of the player factory.
 
@@ -11,12 +11,12 @@ The shape follows the options object of `createActor` in XState. It also keeps t
 
 ## Type Parameters
 
-| Type Parameter                                                                                 |
-| ---------------------------------------------------------------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
+| Type Parameter                                                                                                                      |
+| ----------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-tmachine"></a> `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) |
 
 ## Properties
 
-| Property                                   | Type                                                                     | Description                                                                                                                                                                                                                                                                                     | Defined in                                                                                                                               |
-| ------------------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-snapshot"></a> `snapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\> | The persisted XState snapshot. The factory restores the actor state from it. Its type is the `ActorOptions["snapshot"]` type of XState, which is the exact type that `createActor` accepts and that `getPersistedSnapshot()` returns. The restore of a stored snapshot therefore needs no cast. | [packages/play-xstate/src/types.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-xstate/src/types.ts#L142) |
+| Property                                   | Type                                                                     | Description                                                                                                                                                                                                                                                                                     | Defined in                                                                                                                                    |
+| ------------------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-snapshot"></a> `snapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\> | The persisted XState snapshot. The factory restores the actor state from it. Its type is the `ActorOptions["snapshot"]` type of XState, which is the exact type that `createActor` accepts and that `getPersistedSnapshot()` returns. The restore of a stored snapshot therefore needs no cast. | [packages/play-xstate/src/types.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/types.ts#L142) |