@xmachines/docs 6.1.0 → 7.1.0

package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L58)
+Defined in: [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L58)
 
 One entry of the map between a state ID and a path.
 
@@ -22,7 +22,7 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 ## Properties
 
-| Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                               |
-| --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L62) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [packages/play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L60) |
+| Property                                | Modifier   | Type     | Description                                                                                      | Defined in                                                                                                                                                    |
+| --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L62) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"`                          | [packages/play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L60) |

package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md

@@ -2,7 +2,7 @@
 
 # Interface: RouterBridge
 
-Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L436)
+Defined in: [packages/play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L436)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L453)
+Defined in: [packages/play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L453)
 
 Connects the router bridge to the Actor
 
@@ -84,7 +84,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L469)
+Defined in: [packages/play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L469)
 
 Disconnects the router bridge from the Actor
 

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

@@ -3,113 +3,98 @@
 # Variable: PlayRouterProvider
 
 ```ts
-const PlayRouterProvider: DefineComponent<
-	ExtractPropTypes<{
-		actor: {
-			required: true;
-			type: PropType<RoutableActor>;
-		};
-		basePath: {
-			default: undefined;
-			required: false;
-			type: StringConstructor;
-		};
-		basePathParams: {
-			default: undefined;
-			required: false;
-			type: PropType<Record<string, string | number>>;
-		};
-		compiledCache: {
-			default: undefined;
-			required: false;
-			type: PropType<KeyValueCache<URLPatternLike>>;
-		};
-		patternCache: {
-			default: undefined;
-			required: false;
-			type: PropType<KeyValueCache<ParsedPattern>>;
-		};
-		renderer: {
-			required: true;
-			type: PropType<(actor, router) => VNodeChild>;
-		};
-		routeMap: {
-			required: true;
-			type: PropType<RouteMap>;
-		};
-		router: {
-			required: true;
-			type: PropType<RouterClassic>;
-		};
-	}>,
-	() => VNodeChild,
-	{},
-	{},
-	{},
-	ComponentOptionsMixin,
-	ComponentOptionsMixin,
-	{},
-	string,
-	PublicProps,
-	ToResolvedProps<
-		ExtractPropTypes<{
-			actor: {
-				required: true;
-				type: PropType<RoutableActor>;
-			};
-			basePath: {
-				default: undefined;
-				required: false;
-				type: StringConstructor;
-			};
-			basePathParams: {
-				default: undefined;
-				required: false;
-				type: PropType<Record<string, string | number>>;
-			};
-			compiledCache: {
-				default: undefined;
-				required: false;
-				type: PropType<KeyValueCache<URLPatternLike>>;
-			};
-			patternCache: {
-				default: undefined;
-				required: false;
-				type: PropType<KeyValueCache<ParsedPattern>>;
-			};
-			renderer: {
-				required: true;
-				type: PropType<(actor, router) => VNodeChild>;
-			};
-			routeMap: {
-				required: true;
-				type: PropType<RouteMap>;
-			};
-			router: {
-				required: true;
-				type: PropType<RouterClassic>;
-			};
-		}>,
-		{}
-	>,
-	{
-		basePath: string;
-		basePathParams: Record<string, string | number>;
-		compiledCache: KeyValueCache<URLPatternLike>;
-		patternCache: KeyValueCache<ParsedPattern>;
-	},
-	{},
-	{},
-	{},
-	string,
-	ComponentProvideOptions,
-	true,
-	{},
-	any
->;
+const PlayRouterProvider: DefineComponent<ExtractPropTypes<{
+  actor: {
+     required: true;
+     type: PropType<RoutableActor>;
+  };
+  basePath: {
+     default: undefined;
+     required: false;
+     type: StringConstructor;
+  };
+  basePathParams: {
+     default: undefined;
+     required: false;
+     type: PropType<Record<string, string | number>>;
+  };
+  compiledCache: {
+     default: undefined;
+     required: false;
+     type: PropType<KeyValueCache<URLPatternLike>>;
+  };
+  patternCache: {
+     default: undefined;
+     required: false;
+     type: PropType<KeyValueCache<ParsedPattern>>;
+  };
+  renderer: {
+     required: true;
+     type: PropType<(actor, router) => VNodeChild>;
+  };
+  routeMap: {
+     required: true;
+     type: PropType<RouteMap>;
+  };
+  router: {
+     required: true;
+     type: PropType<RouterClassic>;
+  };
+}>, () => VNodeChild, {
+}, {
+}, {
+}, ComponentOptionsMixin, ComponentOptionsMixin, {
+}, string, PublicProps, ToResolvedProps<ExtractPropTypes<{
+  actor: {
+     required: true;
+     type: PropType<RoutableActor>;
+  };
+  basePath: {
+     default: undefined;
+     required: false;
+     type: StringConstructor;
+  };
+  basePathParams: {
+     default: undefined;
+     required: false;
+     type: PropType<Record<string, string | number>>;
+  };
+  compiledCache: {
+     default: undefined;
+     required: false;
+     type: PropType<KeyValueCache<URLPatternLike>>;
+  };
+  patternCache: {
+     default: undefined;
+     required: false;
+     type: PropType<KeyValueCache<ParsedPattern>>;
+  };
+  renderer: {
+     required: true;
+     type: PropType<(actor, router) => VNodeChild>;
+  };
+  routeMap: {
+     required: true;
+     type: PropType<RouteMap>;
+  };
+  router: {
+     required: true;
+     type: PropType<RouterClassic>;
+  };
+}>, {
+}>, {
+  basePath: string;
+  basePathParams: Record<string, string | number>;
+  compiledCache: KeyValueCache<URLPatternLike>;
+  patternCache: KeyValueCache<ParsedPattern>;
+}, {
+}, {
+}, {
+}, string, ComponentProvideOptions, true, {
+}, any>;
 ```
 
-Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-vue-router/src/play-router-provider.ts#L18)
+Defined in: [packages/play-vue-router/src/play-router-provider.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-vue-router/src/play-router-provider.ts#L18)
 
 PlayRouterProvider — the Vue wrapper of VueRouterBridge.
 

package/api/@xmachines/play-xstate/README.md

@@ -4,13 +4,14 @@
 
 > XState v5 adapter for the XMachines Play Architecture. It binds a state machine to the actor base, with atom-driven reactivity and a router integration.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
 
 ---
 
-> **Browser floor: Chrome 110, Firefox 115, Safari 16.4.** This package calls the ES2023
-> change-by-copy array methods, so a browser below that floor throws
-> `TypeError: ... is not a function`. The root README carries the table.
+> **Browser floor:** the table of the root README covers this package. Its own code calls
+> no ES2023 change-by-copy array method, and its routing capability imports only types from
+> [`@xmachines/play-router`](../play-router/README.md). A router bridge of play-router sets
+> the floor of the table.
 
 ## Installation
 
@@ -117,21 +118,36 @@ machine cannot be `undefined`, the first argument of the factory is necessary. A
 input is then a compile error, not an actor that stops in an error status.
 
 ```typescript
-type PlayerFactory<TMachine> =
+import type { AnyStateMachine, InputFrom } from "xstate";
+import type { PlayerActor, PlayerFactoryResumeOptions } from "@xmachines/play-xstate";
+
+type PlayerFactory<TMachine extends AnyStateMachine, TCapabilities extends object = object> =
 	undefined extends InputFrom<TMachine>
 		? (
 				input?: InputFrom<TMachine>,
 				options?: PlayerFactoryResumeOptions<TMachine>,
-			) => PlayerActor<TMachine>
+			) => PlayerActor<TMachine> & TCapabilities
 		: (
 				input: InputFrom<TMachine>,
 				options?: PlayerFactoryResumeOptions<TMachine>,
-			) => PlayerActor<TMachine>;
+			) => PlayerActor<TMachine> & TCapabilities;
 ```
 
+`TCapabilities` is what `compose` adds, for example `Routable` of [`@xmachines/play-router`](../play-router/README.md).
+
 #### Restoring from a snapshot
 
 ```typescript
+import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine, with an input and routed states
+
+const createPlayer = definePlayer({ machine, actor: compose(PlayerActor, withRouting) });
+const actor = createPlayer({ userId: "alice" });
+actor.start();
+
 const snapshot = actor.getPersistedSnapshot();
 actor.stop();
 
@@ -184,6 +200,9 @@ carries the route utilities — `deriveRoute`, `isAbsoluteRoute`, `buildRouteUrl
 import { definePlayer, PlayerActor, compose } from "@xmachines/play-xstate";
 import { withRouting } from "@xmachines/play-xstate/routing";
 import { withView } from "@xmachines/play-xstate/view";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
 
 // Both capabilities
 const createPlayer = definePlayer({
@@ -203,6 +222,15 @@ const createBare = definePlayer({ machine });
 **A lifecycle hook receives the bare actor.** `PlayerOptions` is typed before the class is composed, so it cannot name the capabilities, and a narrower hook parameter is refused under `strictFunctionTypes`. A hook that reads `currentRoute` or `currentView` reads them through a binding of the composed type:
 
 ```typescript
+import { definePlayer, PlayerActor, compose } from "@xmachines/play-xstate";
+import { withRouting } from "@xmachines/play-xstate/routing";
+import { withView } from "@xmachines/play-xstate/view";
+import type { Routable } from "@xmachines/play-router";
+import type { Viewable } from "@xmachines/play-view";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
+
 let composed: PlayerActor<typeof machine> & Routable & Viewable;
 
 const actor = definePlayer({
@@ -256,6 +284,11 @@ the path yourself, when you run work that belongs to a change of the route alone
 
 ```typescript
 import { watchAtom } from "@xmachines/play-atom";
+import type { PlayerActor } from "@xmachines/play-xstate";
+import type { Routable } from "@xmachines/play-router";
+import type { AnyStateMachine } from "xstate";
+
+declare const actor: PlayerActor<AnyStateMachine> & Routable; // composed with withRouting
 
 const stop = watchAtom(actor.currentRoute, (route) => {
 	console.log("Route changed:", route);
@@ -277,22 +310,32 @@ This package gives no guard utility. Compose a guard with the `and()`, `or()` an
 import { and, not, setup } from "xstate";
 
 const machine = setup({
+	types: {
+		context: {} as { userId: string; role: string },
+		events: {} as { type: "accessAdmin" } | { type: "accessLogin" },
+	},
 	guards: {
 		isLoggedIn: ({ context }) => context.userId !== "",
 		hasAdminRole: ({ context }) => context.role === "admin",
 	},
 }).createMachine({
+	context: { userId: "", role: "guest" },
+	initial: "home",
 	on: {
 		accessAdmin: {
 			guard: and(["isLoggedIn", "hasAdminRole"]),
-			target: "adminPanel",
+			target: ".adminPanel",
 		},
 		accessLogin: {
 			guard: not("isLoggedIn"),
-			target: "login",
+			target: ".login",
 		},
 	},
-	// ...
+	states: {
+		home: {},
+		adminPanel: {},
+		login: {},
+	},
 });
 ```
 
@@ -316,6 +359,7 @@ import { formatPlayRouteTransitions } from "@xmachines/play-xstate/routing";
 
 const config = formatPlayRouteTransitions({
 	id: "app",
+	initial: "home",
 	states: {
 		home: {
 			id: "home",
@@ -350,6 +394,10 @@ with `asDisposable` of [`@xmachines/core/utils`](../core/README.md):
 
 ```typescript
 import { asDisposable } from "@xmachines/core/utils";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
 
 {
 	const actor = definePlayer({ machine })();
@@ -370,6 +418,10 @@ includes [`@statelyai/inspect`](https://stately.ai/docs/inspector):
 
 ```typescript
 import { createBrowserInspector } from "@statelyai/inspect";
+import { definePlayer } from "@xmachines/play-xstate";
+import type { AnyStateMachine } from "xstate";
+
+declare const machine: AnyStateMachine; // your machine
 
 const { inspect } = createBrowserInspector();
 const createPlayer = definePlayer({ machine, options: { inspect } });
@@ -431,7 +483,7 @@ every consumer, including one that composes no routing.
 The string form declares the path only. The object form declares the path and the
 behaviour of the generated `play.route` transition:
 
-```typescript
+```typescript fragment
 meta: {
 	route: {
 		path: "/doc/:docId",
@@ -469,7 +521,7 @@ An unknown `handler` value throws `InvalidRouteHandlerError` at the format time.
 The `data` field follows the `WithDynamicParams` shape of XState, so the function form
 reads the context and the event:
 
-```typescript
+```typescript fragment
 data: ({ context, event }) => ({ title: `Document ${event.params?.docId}` });
 ```
 

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

@@ -2,7 +2,7 @@
 
 # Class: ActorThrewNonErrorError
 
-Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L309)
+Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-xstate/src/errors.ts#L309)
 
 The actor gives this error to `PlayerOptions.onError` when it failed with a value
 that is not an `Error`, for example after a machine action ran
@@ -46,7 +46,7 @@ definePlayer({
 new ActorThrewNonErrorError(value): ActorThrewNonErrorError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L310)
+Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-xstate/src/errors.ts#L310)
 
 #### Parameters
 
@@ -64,15 +64,15 @@ Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-
 
 ## Properties
 
-| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                 |
-| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56) |
-| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                          |
-| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46) |
-| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                          |
-| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                          |
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                      |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                               |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L56) |
+| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                               |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                               |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L46) |
+| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                               |
+| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                               |
 
 ## Methods
 

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

@@ -2,7 +2,7 @@
 
 # Class: InvalidEventError
 
-Defined in: [packages/play-xstate/src/errors.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L264)
+Defined in: [packages/play-xstate/src/errors.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-xstate/src/errors.ts#L264)
 
 `PlayerActor.send()` throws this error when the event argument is not a plain
 object.
@@ -44,7 +44,7 @@ try {
 new InvalidEventError(detail): InvalidEventError;
 ```
 
-Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L268)
+Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-xstate/src/errors.ts#L268)
 
 #### Parameters
 
@@ -62,16 +62,16 @@ Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-
 
 ## Properties
 
-| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                                 |
-| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56)                 |
-| <a id="property-detail"></a> `detail`                   | `readonly` | `unknown` | The value in question, from the `send()` call.                                                                                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:266](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L266) |
-| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                          |
-| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46)                 |
-| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                          |
-| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                          |
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                                      |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause)                     | -                                                                                                                                               |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                         | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L56)                 |
+| <a id="property-detail"></a> `detail`                   | `readonly` | `unknown` | The value in question, from the `send()` call.                                                                                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                                                | [packages/play-xstate/src/errors.ts:266](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-xstate/src/errors.ts#L266) |
+| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message)                 | -                                                                                                                                               |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name)                       | -                                                                                                                                               |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L46)                 |
+| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack)                     | -                                                                                                                                               |
+| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | -                                                                                                                                               |
 
 ## Methods