@xmachines/docs 2.2.0 → 4.0.0

package/api/@xmachines/play-actor/classes/AbstractActor.md

@@ -1,505 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-actor](../README.md) / AbstractActor
-
-# Abstract Class: AbstractActor\<TLogic, TEvent\>
-
-Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L197)
-
-The abstract base class of an actor of the Play Architecture.
-
-It observes the state through the signals, and it works with the tools of the
-XState ecosystem, such as the devtools and the inspection. It also exposes the
-reactive signals of the communication with the infrastructure layer.
-
-**A subclass IS the actor.** Give the logic _and_ its options to
-`super(logic, options)`, then observe `this`. A separate actor beside this
-instance leaves this instance as an empty second actor. Every inherited member
-then answers from that empty actor, until you forward each one: `system`,
-`sessionId`, `clock`, the internal `_send` that receives the traffic of
-`sendTo()`, and each member that a later XState version adds.
-
-## Extends
-
-- [`Actor`](https://www.jsdocs.io/package/xstate#Actor)\<`TLogic`\>
-
-## Extended by
-
-- [`PlayerActor`](../../play-xstate/classes/PlayerActor.md)
-
-## Type Parameters
-
-| Type Parameter                                                                           | Default type                                                      | Description                                                  |
-| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
-| `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | -                                                                 | The type of the XState actor logic                           |
-| `TEvent` _extends_ [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)     | [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject) | The constraint of the event type. The default is EventObject |
-
-## Constructors
-
-### Constructor
-
-```ts
-new AbstractActor<TLogic, TEvent>(logic, options?): AbstractActor<TLogic, TEvent>;
-```
-
-Defined in: `xstate`
-
-Creates a new actor instance for the given logic with the provided options,
-if any.
-
-#### Parameters
-
-| Parameter  | Type                                                                            | Description                       |
-| ---------- | ------------------------------------------------------------------------------- | --------------------------------- |
-| `logic`    | `TLogic`                                                                        | The logic to create an actor from |
-| `options?` | [`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\> | Actor options                     |
-
-#### Returns
-
-`AbstractActor`\<`TLogic`, `TEvent`\>
-
-#### Inherited from
-
-```ts
-Actor<TLogic>.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`   | `TLogic`                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                                         | `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)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | -                                                                                                                                                                                                         | `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`         | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\>                                                                                                                                                                                                                                      | 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. | -                 | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L207) |
-| <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<TLogic>>;
-```
-
-Defined in: `xstate`
-
-#### Returns
-
-[`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\>
-
-#### Inherited from
-
-```ts
-Actor.[observable]
-```
-
----
-
-### getPersistedSnapshot()
-
-```ts
-getPersistedSnapshot(): Snapshot<unknown>;
-```
-
-Defined in: `xstate`
-
-Obtain the internal state of the actor, which can be persisted.
-
-#### Returns
-
-[`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>
-
-#### Remarks
-
-The internal state can be persisted from any actor, not only machines.
-
-Note that the persisted state is not the same as the snapshot from
-[Actor.getSnapshot](#getsnapshot). Persisted state represents the internal state of
-the actor, while snapshots represent the actor's last emitted value.
-
-Can be restored with [ActorOptions.state](https://www.jsdocs.io/package/xstate#ActorOptions.state)
-
-#### See
-
-https://stately.ai/docs/persistence
-
-#### Inherited from
-
-```ts
-Actor.getPersistedSnapshot;
-```
-
----
-
-### getSnapshot()
-
-```ts
-getSnapshot(): SnapshotFrom<TLogic>;
-```
-
-Defined in: `xstate`
-
-Read an actor’s snapshot synchronously.
-
-#### Returns
-
-[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>
-
-#### Remarks
-
-The snapshot represent an actor's last emitted value.
-
-When an actor receives an event, its internal state may change. An actor
-may emit a snapshot when a state transition occurs.
-
-Note that some actors, such as callback actors generated with
-`fromCallback`, will not emit snapshots.
-
-#### See
-
-- [Actor.subscribe](#subscribe) to subscribe to an actor’s snapshot values.
-- [Actor.getPersistedSnapshot](#getpersistedsnapshot) to persist the internal state of an actor (which is more than just a snapshot).
-
-#### Inherited from
-
-```ts
-Actor.getSnapshot;
-```
-
----
-
-### on()
-
-```ts
-on<TType>(type, handler): Subscription;
-```
-
-Defined in: `xstate`
-
-#### Type Parameters
-
-| Type Parameter          |
-| ----------------------- |
-| `TType` _extends_ `any` |
-
-#### Parameters
-
-| Parameter | Type                  |
-| --------- | --------------------- |
-| `type`    | `TType`               |
-| `handler` | (`emitted`) => `void` |
-
-#### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-#### Inherited from
-
-```ts
-Actor.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
-
-```ts
-Actor.select;
-```
-
----
-
-### send()
-
-```ts
-abstract send(event): void;
-```
-
-Defined in: [packages/play-actor/src/abstract-actor.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L223)
-
-Sends an event to the Actor.
-
-The constraint is TEvent, which gives the type safety of a concrete
-implementation.
-
-A note for an implementation that wraps `send`, to check the event or to notify a
-hook around it: this declaration is abstract for one reason only, to narrow the
-event type, and TypeScript forbids a `super` call to an abstract member. Reach
-the implementation of XState with `Actor.prototype.send.call(this, event)`
-instead. A concrete declaration permits `super.send()`, but it also forces an
-`override` modifier in every subclass that exists now, and that is a breaking
-change for an adapter outside this repository.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `event`   | `TEvent` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-```ts
-Actor.send;
-```
-
----
-
-### start()
-
-```ts
-start(): this;
-```
-
-Defined in: `xstate`
-
-Starts the Actor from the initial state
-
-#### Returns
-
-`this`
-
-#### Inherited from
-
-```ts
-Actor.start;
-```
-
----
-
-### stop()
-
-```ts
-stop(): this;
-```
-
-Defined in: `xstate`
-
-Stops the Actor and unsubscribe all listeners.
-
-#### Returns
-
-`this`
-
-#### Inherited from
-
-```ts
-Actor.stop;
-```
-
----
-
-### subscribe()
-
-#### Call Signature
-
-```ts
-subscribe(observer): Subscription;
-```
-
-Defined in: `xstate`
-
-Subscribe an observer to an actor’s snapshot values.
-
-##### Parameters
-
-| Parameter  | Type                                                                                                                                           | Description                                                                                                                                  |
-| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| `observer` | [`Observer`](https://www.jsdocs.io/package/xstate#Observer)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\> | Either a plain function that receives the latest snapshot, or an observer object whose `.next(snapshot)` method receives the latest snapshot |
-
-##### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-##### Remarks
-
-The observer will receive the actor’s snapshot value when it is emitted.
-The observer can be:
-
-- A plain function that receives the latest snapshot, or
-- An observer object whose `.next(snapshot)` method receives the latest
-  snapshot
-
-##### Examples
-
-```ts
-// Observer as a plain function
-const subscription = actor.subscribe((snapshot) => {
-	console.log(snapshot);
-});
-```
-
-```ts
-// Observer as an object
-const subscription = actor.subscribe({
-	next(snapshot) {
-		console.log(snapshot);
-	},
-	error(err) {
-		// ...
-	},
-	complete() {
-		// ...
-	},
-});
-```
-
-The return value of `actor.subscribe(observer)` is a subscription object
-that has an `.unsubscribe()` method. You can call
-`subscription.unsubscribe()` to unsubscribe the observer:
-
-```ts
-const subscription = actor.subscribe((snapshot) => {
-	// ...
-});
-
-// Unsubscribe the observer
-subscription.unsubscribe();
-```
-
-When the actor is stopped, all of its observers will automatically be
-unsubscribed.
-
-##### Inherited from
-
-```ts
-Actor.subscribe;
-```
-
-#### Call Signature
-
-```ts
-subscribe(
-   nextListener?,
-   errorListener?,
-   completeListener?): Subscription;
-```
-
-Defined in: `xstate`
-
-Subscribe an observer to an actor’s snapshot values.
-
-##### Parameters
-
-| Parameter           | Type                   |
-| ------------------- | ---------------------- |
-| `nextListener?`     | (`snapshot`) => `void` |
-| `errorListener?`    | (`error`) => `void`    |
-| `completeListener?` | () => `void`           |
-
-##### Returns
-
-[`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
-
-##### Remarks
-
-The observer will receive the actor’s snapshot value when it is emitted.
-The observer can be:
-
-- A plain function that receives the latest snapshot, or
-- An observer object whose `.next(snapshot)` method receives the latest
-  snapshot
-
-##### Examples
-
-```ts
-// Observer as a plain function
-const subscription = actor.subscribe((snapshot) => {
-	console.log(snapshot);
-});
-```
-
-```ts
-// Observer as an object
-const subscription = actor.subscribe({
-	next(snapshot) {
-		console.log(snapshot);
-	},
-	error(err) {
-		// ...
-	},
-	complete() {
-		// ...
-	},
-});
-```
-
-The return value of `actor.subscribe(observer)` is a subscription object
-that has an `.unsubscribe()` method. You can call
-`subscription.unsubscribe()` to unsubscribe the observer:
-
-```ts
-const subscription = actor.subscribe((snapshot) => {
-	// ...
-});
-
-// Unsubscribe the observer
-subscription.unsubscribe();
-```
-
-When the actor is stopped, all of its observers will automatically be
-unsubscribed.
-
-##### Inherited from
-
-```ts
-Actor.subscribe;
-```
-
----
-
-### toJSON()
-
-```ts
-toJSON(): object;
-```
-
-Defined in: `xstate`
-
-#### Returns
-
-`object`
-
-| Name           | Type     | Defined in |
-| -------------- | -------- | ---------- |
-| `id`           | `string` | -          |
-| `xstate$$type` | `number` | -          |
-
-#### Inherited from
-
-```ts
-Actor.toJSON;
-```

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

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

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

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