@xmachines/docs 3.0.0 → 5.0.0

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

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

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

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

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

@@ -1,568 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayerActor
-
-# Class: PlayerActor\<TMachine\>
-
-Defined in: [packages/play-xstate/src/player-actor.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L203)
-
-The concrete XState actor. It implements the signal protocol of the Play Architecture
-
-The class extends [@xmachines/play-actor!AbstractActor](../../play-actor/classes/AbstractActor.md), and therefore the
-`Actor` class of XState. It gives you the XState v5 integration, and it keeps the
-compatibility with the ecosystem, such as the XState inspection and the devtools.
-The constructor of the base class receives the machine. Therefore a `PlayerActor`
-**is** the XState actor, and it is no wrapper around one: every member of the
-XState `Actor` class works on the state of this instance, and this class adds the
-reactive state on the TC39 Signals for the observation by the infrastructure.
-
-**Capabilities:** the class implements both the
-[@xmachines/play-actor!Routable](../../play-actor/interfaces/Routable.md) interface and the
-[@xmachines/play-actor!Viewable](../../play-actor/interfaces/Viewable.md) interface. It therefore supports the
-routing and the view rendering.
-
-**Architectural context:** the class implements **Actor Authority (INV-01)**,
-because the guards of the XState machine control every decision of the
-navigation. The infrastructure observes the signals of the actor (`state`,
-`currentRoute`, and `currentView`), but it changes no state directly: every
-change goes through the event handlers of the state machine.
-
-## Examples
-
-The creation of an actor, and its lifecycle
-
-```typescript
-import { setup } from "xstate";
-import { definePlayer } from "@xmachines/play-xstate";
-
-const machine = setup({}).createMachine({
-	initial: "idle",
-	states: {
-		idle: {
-			meta: {
-				route: "/",
-				// A view spec needs `root` and `elements`. Every other shape derives null.
-				view: {
-					root: "home",
-					elements: { home: { type: "HomePage", props: {}, children: [] } },
-				},
-			},
-		},
-	},
-});
-
-const createPlayer = definePlayer({ machine });
-const actor = createPlayer();
-actor.start();
-
-// Observe the signals
-console.log(actor.currentRoute.get()); // '/'
-console.log(actor.currentView.get()?.root); // 'home'
-```
-
-The signal lifecycle with a watcher
-
-```typescript
-import { Signal } from "@xmachines/play-signals";
-
-const watcher = new Signal.subtle.Watcher(() => {
-	queueMicrotask(() => {
-		const pending = watcher.getPending();
-		console.log("State changed:", actor.state.get());
-	});
-});
-
-watcher.watch(actor.state);
-actor.send({ type: "play.route", to: "#about" });
-// The watcher schedules its own notification in a microtask
-```
-
-## See
-
-- [Play RFC](../../../../rfc/play.md)
-- [definePlayer](../functions/definePlayer.md) for the creation through a factory
-- [@xmachines/play-actor!AbstractActor](../../play-actor/classes/AbstractActor.md) for the signal protocol
-- [@xmachines/play-actor!Routable](../../play-actor/interfaces/Routable.md) for the routing capability
-- [@xmachines/play-actor!Viewable](../../play-actor/interfaces/Viewable.md) for the view rendering capability
-
-## Remarks
-
-**The routing:** this actor supports the `route: {}` config pattern of XState and
-also a `play.route` event with parameters. The `deriveRoute()` function reads
-`meta.route`, which is the Stately pattern, for a URL template, and it substitutes
-each parameter.
-
-**The pattern of the view signal:** the `currentView` signal is a direct
-`Signal.State`, and not a `Signal.Computed`. The propagation to a watcher in
-PlayRenderer is therefore correct. The class derives each view at the entry of a
-state and keeps it, and it computes no view on a read.
-
-## Extends
-
-- [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>\>
-
-## Type Parameters
-
-| Type Parameter                                                                                 | Description                             |
-| ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| `TMachine` _extends_ [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The type of the XState v5 state machine |
-
-## Implements
-
-- [`Routable`](../../play-actor/interfaces/Routable.md)
-- [`Viewable`](../../play-actor/interfaces/Viewable.md)
-
-## Constructors
-
-### Constructor
-
-```ts
-new PlayerActor<TMachine>(
-   machine,
-   options,
-   input?,
-restoredSnapshot?): PlayerActor<TMachine>;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L361)
-
-#### Parameters
-
-| Parameter           | Type                                                                        |
-| ------------------- | --------------------------------------------------------------------------- |
-| `machine`           | `TMachine`                                                                  |
-| `options`           | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\>             |
-| `input?`            | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\> |
-| `restoredSnapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>    |
-
-#### Returns
-
-`PlayerActor`\<`TMachine`\>
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`constructor`](../../play-actor/classes/AbstractActor.md#constructor)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Overrides                                                                                                                        | Inherited from                                                                                                                           | Defined in                                                                                                                                             |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-_parent"></a> `_parent?`          | `public`   | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef)                                                                   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`_parent`](../../play-actor/classes/AbstractActor.md#property-_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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`clock`](../../play-actor/classes/AbstractActor.md#property-clock)         | -                                                                                                                                                      |
-| <a id="property-currentroute"></a> `currentRoute` | `public`   | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | A TC39 `Signal.Computed`. It derives the current URL path from the `meta.route` template of the active machine state and from the context of the actor. It returns `null` when the current state has no `meta.route` field, and also when it cannot resolve the complete route template. A necessary `:param` that the context does not hold is caught inside the signal, and a `MissingRouteParamError` therefore never leaves `get()`: that condition is temporary during a transition, and the signal computes the value again on the next snapshot. **Example** `// It returns "/profile/alice" when context.params.userId === "alice", // and null while the param is still absent. const route = actor.currentRoute.get();`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | -                                                                                                                                        | [packages/play-xstate/src/player-actor.ts:305](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L305) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The reactive signal of the current view spec. The signal derives the spec from the `meta.view` metadata of the active state. It emits a **new object reference** on each real change of the view on the screen: the view of a different state, or a change of a param or of the context that changes the resolved spec. A re-entry with `reenter: true` and new params also changes the spec. A snapshot that changes no view on the screen, such as an assign of the context alone, keeps the previous reference. A provider below the signal therefore mounts the UI again not on every event. The `PlaySpec` of the emission carries the context of the machine in its composed `state` field, under the read-only `/context` subtree. A spec therefore reads the context, and also each URL param, through the ordinary state grammar (`{ $state: "/context/params/section" }`). The context-projection module of `@xmachines/play-actor` holds the complete contract. The signal returns `null` when the current state has no `meta.view` metadata. Two states can declare two separate `meta.view` literals with an identical structure. A transition between those two states then emits two different references, and a provider mounts the UI again. Move the shared literal into one `typedSpec` constant, and the identity then removes the duplicate. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.root); // for example "root" console.log(view.elements); // the Spec elements of @xmachines/json-render-core }` | -                                                                                                                                | -                                                                                                                                        | [packages/play-xstate/src/player-actor.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L359) |
-| <a id="property-id"></a> `id`                     | `public`   | `string`                                                                                                                            | The unique identifier for this actor relative to its parent.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`id`](../../play-actor/classes/AbstractActor.md#property-id)               | -                                                                                                                                                      |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it, and it never changes, also when the code restores the actor from a snapshot. A router bridge compares it with the browser URL, and it therefore separates a deep link (a URL that is not the initial one → the router wins) from a restore (the initial URL, and the actor at a different route from the restore → the actor wins). `deriveInitialRoute` derives the value statically from the machine definition, with the pure `initialTransition` helper of XState: the chain of the initial states and their `meta.route` templates are fixed at the moment of the machine definition, and the substitution of a `:param` uses the real initial context of the machine for the `input` of this actor. The code makes no second actor, and a snapshot of a restore changes the value never: it is always the **default** initial route of the machine.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | -                                                                                                                                | -                                                                                                                                        | [packages/play-xstate/src/player-actor.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L324) |
-| <a id="property-logic"></a> `logic`               | `public`   | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                               | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`logic`](../../play-actor/classes/AbstractActor.md#property-logic)         | -                                                                                                                                                      |
-| <a id="property-options"></a> `options`           | `public`   | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\>                                       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`options`](../../play-actor/classes/AbstractActor.md#property-options)     | -                                                                                                                                                      |
-| <a id="property-ref"></a> `ref`                   | `public`   | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<`any`, `any`, `any`\>                                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`ref`](../../play-actor/classes/AbstractActor.md#property-ref)             | -                                                                                                                                                      |
-| <a id="property-sessionid"></a> `sessionId`       | `public`   | `string`                                                                                                                            | The globally unique process ID for this invocation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`sessionId`](../../play-actor/classes/AbstractActor.md#property-sessionid) | -                                                                                                                                                      |
-| <a id="property-src"></a> `src`                   | `public`   | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)                                                | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`src`](../../play-actor/classes/AbstractActor.md#property-src)             | -                                                                                                                                                      |
-| <a id="property-state"></a> `state`               | `public`   | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\>                    | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | -                                                                                                                                        | [packages/play-xstate/src/player-actor.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L264) |
-| <a id="property-system"></a> `system`             | `public`   | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem)                                                             | The system to which this actor belongs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`system`](../../play-actor/classes/AbstractActor.md#property-system)       | -                                                                                                                                                      |
-| <a id="property-systemid"></a> `systemId`         | `public`   | `string` \| `undefined`                                                                                                             | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid)   | -                                                                                                                                                      |
-
-## Methods
-
-### \[dispose\]()
-
-```ts
-dispose: void;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:779](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L779)
-
-Stops the actor when the scope of a `using` declaration ends.
-
-The actor is a `Disposable`, so a scope that owns one writes no teardown:
-
-```ts
-{
-	using actor = definePlayer({ machine })();
-	actor.start();
-	actor.send({ type: "go" });
-	// stop() runs here, and it runs even when send() throws
-}
-```
-
-The release is [stop](#stop), which is synchronous and idempotent. `Disposable` and
-not `AsyncDisposable`: a `Disposable` serves `using` AND `await using`, while an
-`AsyncDisposable` raises a TypeError under a plain `using`.
-
-The key is `DISPOSE` of `@xmachines/play` and not a bare `Symbol.dispose`, so that
-the method still answers a `using` that a bundler downlevelled for a target without
-the well-known symbol.
-
-#### Returns
-
-`void`
-
----
-
-### \[observable\]()
-
-```ts
-observable: InteropSubscribable<any>;
-```
-
-Defined in: `xstate`
-
-#### Returns
-
-[`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<`any`\>
-
-#### Inherited from
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`[observable]`](../../play-actor/classes/AbstractActor.md#observable)
-
----
-
-### can()
-
-```ts
-can(event): boolean;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L277)
-
-Tells you if the current state of the actor accepts the given event.
-
-The type is the event union of the machine. An unknown event type is therefore a
-compile error. The method evaluates the event against the snapshot signal.
-
-#### Parameters
-
-| Parameter | Type                                                                                  |
-| --------- | ------------------------------------------------------------------------------------- |
-| `event`   | [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\> |
-
-#### Returns
-
-`boolean`
-
-#### Example
-
-```typescript
-if (actor.can({ type: "auth.logout" })) { ... }
-```
-
----
-
-### ~~dispose()~~
-
-```ts
-dispose(): void;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:753](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L753)
-
-The dispose method, for the cleanup. It is the alias of [stop](#stop).
-
-#### Returns
-
-`void`
-
-#### Deprecated
-
-Use [stop](#stop), or a `using` declaration. Will be removed in the
-next major.
-
----
-
-### getPersistedSnapshot()
-
-```ts
-getPersistedSnapshot(options?): Snapshot<unknown>;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:697](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L697)
-
-Returns the persisted snapshot of this actor.
-
-Use it to serialize the state, and to restore it later with the
-`restore.snapshot` option of the factory.
-
-#### Parameters
-
-| Parameter  | Type      |
-| ---------- | --------- |
-| `options?` | `unknown` |
-
-#### Returns
-
-[`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`getPersistedSnapshot`](../../play-actor/classes/AbstractActor.md#getpersistedsnapshot)
-
----
-
-### getSnapshot()
-
-```ts
-getSnapshot(): SnapshotFrom<TMachine>;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:596](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L596)
-
-Returns the current snapshot
-
-#### Returns
-
-[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`getSnapshot`](../../play-actor/classes/AbstractActor.md#getsnapshot)
-
----
-
-### on()
-
-```ts
-on<TType>(type, handler): Subscription;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:682](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L682)
-
-Listens for the events that this actor emits with the `emit` action.
-
-#### Type Parameters
-
-| Type Parameter          |
-| ----------------------- |
-| `TType` _extends_ `any` |
-
-#### Parameters
-
-| Parameter | Type                  | Description                                                            |
-| --------- | --------------------- | ---------------------------------------------------------------------- |
-| `type`    | `TType`               | The type of the emitted event to listen for, or `"*"` for every event. |
-| `handler` | (`emitted`) => `void` | The actor calls it with each emitted event that matches.               |
-
-#### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-The subscription, with an `unsubscribe()` method.
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`on`](../../play-actor/classes/AbstractActor.md#on)
-
----
-
-### select()
-
-```ts
-select<TSelected>(selector, equalityFn?): Readable<TSelected>;
-```
-
-Defined in: `xstate`
-
-#### Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `TSelected`    |
-
-#### Parameters
-
-| Parameter     | Type                        |
-| ------------- | --------------------------- |
-| `selector`    | (`snapshot`) => `TSelected` |
-| `equalityFn?` | (`a`, `b`) => `boolean`     |
-
-#### Returns
-
-`Readable`\<`TSelected`\>
-
-#### Inherited from
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`select`](../../play-actor/classes/AbstractActor.md#select)
-
----
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:557](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L557)
-
-Sends an event to this actor.
-
-The guards of the state machine of the actor decide if the event causes a
-transition. Give any event of the event union of the machine: a domain event, a
-routing event, and so on.
-
-#### Parameters
-
-| Parameter | Type                                                                                  | Description                                                      |
-| --------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `event`   | [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\> | An event of the `EventFromLogic<TMachine>` union of the machine. |
-
-#### Returns
-
-`void`
-
-#### Throws
-
-When `event` is not a plain object, for example
-`null`, `undefined`, a string, or a number. Import the class from
-`@xmachines/play-xstate/errors`.
-
-#### Example
-
-```typescript
-// A domain event, with the type of the event union of the machine
-actor.send({ type: "auth.login", userId: "123" });
-
-// A routing event
-actor.send({ type: "play.route", to: "#home" });
-```
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`send`](../../play-actor/classes/AbstractActor.md#send)
-
----
-
-### start()
-
-```ts
-start(): this;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:483](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L483)
-
-Starts the actor.
-
-The method fires `onStart` on each real start, which is every transition from
-"not running" to "running". A start after a stop is such a transition, and XState
-permits it: its own `start()` stops only while the actor RUNS already. A second
-call while the actor runs fires no hook. Therefore a defensive double mount runs
-the side effects of `onStart` one time for one real start.
-
-#### Returns
-
-`this`
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`start`](../../play-actor/classes/AbstractActor.md#start)
-
----
-
-### stop()
-
-```ts
-stop(): this;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:513](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L513)
-
-Stops the actor and cleans up.
-
-The method fires `onStop` only when the actor ran. This matches XState, where a
-stop of an actor that never started, or of an actor that stopped already, does
-nothing and tears nothing down. Therefore the paired cleanup runs never two
-times, and it runs never against a resource that `onStart` did not take. A stop
-does not close the actor for ever: a later `start()` is a new lifecycle, and it
-fires `onStart` again.
-
-#### Returns
-
-`this`
-
-#### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`stop`](../../play-actor/classes/AbstractActor.md#stop)
-
----
-
-### subscribe()
-
-#### Call Signature
-
-```ts
-subscribe(observer): Subscription;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:619](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L619)
-
-Subscribes to the snapshot updates of this actor.
-
-The method accepts an observer object, exactly like `Actor.subscribe` of XState.
-
-##### Parameters
-
-| Parameter  | Type                                                                                                                                             | Description                                                        |
-| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
-| `observer` | [`Observer`](https://www.jsdocs.io/package/xstate#Observer)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>\> | The observer, with a `next`, an `error`, and a `complete` handler. |
-
-##### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-The subscription, with an `unsubscribe()` method.
-
-##### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`subscribe`](../../play-actor/classes/AbstractActor.md#subscribe)
-
-#### Call Signature
-
-```ts
-subscribe(
-   nextListener?,
-   errorListener?,
-   completeListener?): Subscription;
-```
-
-Defined in: [packages/play-xstate/src/player-actor.ts:630](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-xstate/src/player-actor.ts#L630)
-
-Subscribes to the snapshot updates of this actor.
-
-The method accepts listener functions, exactly like `Actor.subscribe` of XState.
-
-##### Parameters
-
-| Parameter           | Type                   | Description                                                                      |
-| ------------------- | ---------------------- | -------------------------------------------------------------------------------- |
-| `nextListener?`     | (`snapshot`) => `void` | The listener function of each snapshot.                                          |
-| `errorListener?`    | (`error`) => `void`    | The actor calls it on an error.                                                  |
-| `completeListener?` | () => `void`           | The actor calls it when it completes, which means that it reaches a final state. |
-
-##### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-The subscription, with an `unsubscribe()` method.
-
-##### Overrides
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`subscribe`](../../play-actor/classes/AbstractActor.md#subscribe)
-
----
-
-### toJSON()
-
-```ts
-toJSON(): object;
-```
-
-Defined in: `xstate`
-
-#### Returns
-
-`object`
-
-| Name           | Type     | Defined in |
-| -------------- | -------- | ---------- |
-| `id`           | `string` | -          |
-| `xstate$$type` | `number` | -          |
-
-#### Inherited from
-
-[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`toJSON`](../../play-actor/classes/AbstractActor.md#tojson)