@xmachines/docs 3.0.0 → 4.0.0

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

@@ -1,11 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMetadata
-
-# Type Alias: RouteMetadata
-
-```ts
-type RouteMetadata = string | RouteObject;
-```
-
-Defined in: [play-router/src/types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L56)
-
-The route metadata of the `meta.route` field of a state machine.

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [packages/play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
-
-Creates a `RouteMap` from an XState state machine.
-
-The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
-stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
-converts each change of the browser URL into a `play.route` actor event, and each
-actor route into a URL.
-
-## Parameters
-
-| Parameter  | Type                                                                      | Description                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
-
-## Returns
-
-[`RouteMap`](../classes/RouteMap.md)
-
-A `RouteMap` for each adapter on `RouterBridgeBase`.
-
-## Example
-
-```typescript
-import { createRouteMap } from "@xmachines/play-router";
-import { connectRouter } from "@xmachines/play-dom-router";
-
-const routeMap = createRouteMap(myMachine);
-const disconnect = connectRouter({ actor, router, routeMap });
-```

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

@@ -1,471 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / AbstractActor
-
-# Abstract Interface: AbstractActor\<TLogic, TEvent\>
-
-Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.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`\>
-
-## 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 |
-
-## 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/v3.0.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](../../play-actor/classes/AbstractActor.md#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](../../play-actor/classes/AbstractActor.md#subscribe) to subscribe to an actor’s snapshot values.
-- [Actor.getPersistedSnapshot](../../play-actor/classes/AbstractActor.md#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/v3.0.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-solid-router/type-aliases/RoutableActor.md

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

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
-
-Creates a `RouteMap` from an XState state machine.
-
-The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
-stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
-converts each change of the browser URL into a `play.route` actor event, and each
-actor route into a URL.
-
-## Parameters
-
-| Parameter  | Type                                                                      | Description                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
-
-## Returns
-
-[`RouteMap`](../classes/RouteMap.md)
-
-A `RouteMap` for each adapter on `RouterBridgeBase`.
-
-## Example
-
-```typescript
-import { createRouteMap } from "@xmachines/play-router";
-import { connectRouter } from "@xmachines/play-dom-router";
-
-const routeMap = createRouteMap(myMachine);
-const disconnect = connectRouter({ actor, router, routeMap });
-```

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

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-svelte-spa-router](../README.md) / RoutableActor
-
-# Type Alias: RoutableActor
-
-```ts
-type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
-```
-
-Defined in: [play-svelte-spa-router/src/types.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-svelte-spa-router/src/types.ts#L6)

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

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / createRouteMap
-
-# Function: createRouteMap()
-
-```ts
-function createRouteMap(machine, options?): RouteMap;
-```
-
-Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
-
-Creates a `RouteMap` from an XState state machine.
-
-The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
-stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
-converts each change of the browser URL into a `play.route` actor event, and each
-actor route into a URL.
-
-## Parameters
-
-| Parameter  | Type                                                                      | Description                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
-
-## Returns
-
-[`RouteMap`](../classes/RouteMap.md)
-
-A `RouteMap` for each adapter on `RouterBridgeBase`.
-
-## Example
-
-```typescript
-import { createRouteMap } from "@xmachines/play-router";
-import { connectRouter } from "@xmachines/play-dom-router";
-
-const routeMap = createRouteMap(myMachine);
-const disconnect = connectRouter({ actor, router, routeMap });
-```

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

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-sveltekit-router](../README.md) / RoutableActor
-
-# Type Alias: RoutableActor
-
-```ts
-type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
-```
-
-Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-sveltekit-router/src/types.ts#L10)