@xmachines/docs 5.0.1 → 6.0.0

package/api/@xmachines/core/utils/functions/safeString.md

@@ -0,0 +1,36 @@
+[API](../../../../README.md) / [@xmachines/core](../../README.md) / [utils](../README.md) / safeString
+
+# Function: safeString()
+
+```ts
+function safeString(value): string;
+```
+
+Defined in: [packages/core/src/utils/describe-value.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/utils/describe-value.ts#L19)
+
+Converts an unknown value into a string, and it trusts that value not.
+
+`String()` itself throws for an object with a null prototype, and for a value whose
+`toString` or `Symbol.toPrimitive` throws. A caller in an error path runs this
+function, and a second throw there replaces the real failure with a `TypeError`. The
+function therefore falls back to the brand, and then to a fixed text.
+
+## Parameters
+
+| Parameter | Type      | Description           |
+| --------- | --------- | --------------------- |
+| `value`   | `unknown` | The value to convert. |
+
+## Returns
+
+`string`
+
+The text of the value. The function throws never.
+
+## Example
+
+```ts
+import { safeString } from "@xmachines/core/utils";
+
+safeString(Object.create(null)); // "[object Object]"
+```

package/api/@xmachines/core/utils/functions/shallowEqualExcept.md

@@ -0,0 +1,42 @@
+[API](../../../../README.md) / [@xmachines/core](../../README.md) / [utils](../README.md) / shallowEqualExcept
+
+# Function: shallowEqualExcept()
+
+```ts
+function shallowEqualExcept(a, b, except?): boolean;
+```
+
+Defined in: [packages/core/src/utils/shallow-equal.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/utils/shallow-equal.ts#L25)
+
+The shallow equality of the own keys, with `Object.is`. It can ignore one key on
+both sides.
+
+The comparison reads the own enumerable string keys of each side, and a key that one
+side carries and the other lacks makes the two unequal, even when its value is
+`undefined`. A value compares by `Object.is`, so `NaN` equals `NaN` and `0` differs from
+`-0`.
+
+The emission dedup of the Play packages reads it: the equality of a slice, the emit
+gate of the player, and the reuse of a composed state.
+
+## Parameters
+
+| Parameter | Type     | Description                                      |
+| --------- | -------- | ------------------------------------------------ |
+| `a`       | `object` | The first object.                                |
+| `b`       | `object` | The second object.                               |
+| `except?` | `string` | A key that the comparison ignores on both sides. |
+
+## Returns
+
+`boolean`
+
+`true` when every other own key holds the same value on both sides.
+
+## Example
+
+```ts
+import { shallowEqualExcept } from "@xmachines/core/utils";
+
+shallowEqualExcept({ a: 1, s: 1 }, { a: 1, s: 2 }, "s"); // true
+```

package/api/@xmachines/core/utils/type-aliases/DisposeKey.md

@@ -0,0 +1,28 @@
+[API](../../../../README.md) / [@xmachines/core](../../README.md) / [utils](../README.md) / DisposeKey
+
+# Type Alias: DisposeKey
+
+```ts
+type DisposeKey = SymbolConstructor extends object ? Key : never;
+```
+
+Defined in: [packages/core/src/utils/disposable.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/utils/disposable.ts#L33)
+
+The dispose key of the ambient library, and `never` where the consumer omits it.
+
+`Symbol.dispose` and the `Disposable` interface arrive with `lib.esnext.disposable`. A
+consumer gets that library from `"lib": ["ESNext"]`, and NOT from `"lib": ["ES2022"]`
+or `["ES2023"]`. A published `.d.ts` that names either one therefore refuses to
+type-check for every consumer of the second kind, and this package cannot ask for the
+library on their behalf: TypeScript copies no `/// <reference lib="..." />` into
+declaration output.
+
+The conditional asks the compiler instead of naming the key. Where the library is
+present the key resolves to `typeof Symbol.dispose`, and the value that
+[asDisposable](../functions/asDisposable.md) returns is a `Disposable` that a `using` declaration accepts. Where
+the library is absent the key resolves to `never`, and [DisposeMember](DisposeMember.md) adds no
+member. That consumer loses nothing, because `using` is syntax that the same library
+gates: a compiler that cannot name `Symbol.dispose` cannot compile the form either.
+
+The runtime is not involved. [asDisposable](../functions/asDisposable.md) stores the release under
+[DISPOSE](../variables/DISPOSE.md) whatever the consumer declares, so one build serves both.

package/api/@xmachines/core/utils/type-aliases/DisposeMember.md

@@ -0,0 +1,14 @@
+[API](../../../../README.md) / [@xmachines/core](../../README.md) / [utils](../README.md) / DisposeMember
+
+# Type Alias: DisposeMember
+
+```ts
+type DisposeMember = { [Key in DisposeKey]: () => void };
+```
+
+Defined in: [packages/core/src/utils/disposable.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/utils/disposable.ts#L43)
+
+The dispose member of a `Disposable`, and no member where the consumer omits the library.
+
+[asDisposable](../functions/asDisposable.md) returns its input with this member. See [DisposeKey](DisposeKey.md) for the
+reason that the key can resolve to `never`.

package/api/@xmachines/{play-router/index → core/utils}/variables/DISPOSE.md

@@ -1,4 +1,4 @@
-[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / DISPOSE
+[API](../../../../README.md) / [@xmachines/core](../../README.md) / [utils](../README.md) / DISPOSE
 
 # Variable: DISPOSE
 
@@ -6,7 +6,7 @@
 const DISPOSE: DisposeKey;
 ```
 
-Defined in: [packages/play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L94)
+Defined in: [packages/core/src/utils/disposable.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/utils/disposable.ts#L71)
 
 The key that a release is stored under.
 
@@ -25,10 +25,10 @@ The type assertion states what the fallback IS. `Symbol.for` returns a plain `sy
 TypeScript declares `Symbol.dispose` as a `unique symbol`, and no expression produces
 a `unique symbol` other than the declaration itself.
 
-This binding resolves ONE time, when the module evaluates. [asCleanup](../../../play/index/functions/asCleanup.md) therefore
-reads `Symbol.dispose` again at each call and stores the release under both keys, so a
-polyfill that installs the well-known symbol after this module evaluates still finds
-the release. A class or an object literal that writes `[DISPOSE]()` has no such second
-chance: it carries the key that existed when it was defined. Install an Explicit
-Resource Management polyfill before the first import of `@xmachines/play`, which is the
-ordinary contract of a polyfill.
+This binding resolves ONE time, when the module evaluates. [asDisposable](../functions/asDisposable.md)
+therefore reads `Symbol.dispose` again at each call, and it stores the release under
+both keys. A polyfill that installs the well-known symbol after this module evaluates
+still finds the release. A class or an object literal that writes `[DISPOSE]()` has no
+such second chance: it carries the key that existed when it was defined. Install an
+Explicit Resource Management polyfill before the first import of `@xmachines/core/utils`,
+which is the ordinary contract of a polyfill.

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

@@ -4,29 +4,32 @@
 
 > Core protocol layer for the Universal Player Architecture. It defines `PlayEvent`, `PlayError`, and the contracts that keep the business logic loosely coupled to the runtime adapters.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.1-blue)](https://www.npmjs.com/package/@xmachines/play)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play)
 
 ---
 
 ## Installation
 
 ```bash
-pnpm add @xmachines/play
+pnpm add @xmachines/play @xmachines/core
 ```
 
+**Peer dependencies.** Install them with the package:
+
+- [`@xmachines/core`](../core/README.md) — the base of the errors. `PlayError` extends `BaseError` of its `errors` subpath.
+
 > **This package requires Node.js `>= 24.0.0`.** Every package is an ES module (`"type": "module"`).
 
 ---
 
 ## Overview
 
-`@xmachines/play` is the base package of the XMachines ecosystem. It defines the smallest set of types and utilities that every other `@xmachines/*` package builds on:
+`@xmachines/play` is the protocol package of the XMachines ecosystem. It defines the smallest set of types and utilities that every other Play package builds on:
 
 - **`PlayEvent<TPayload>`** — the universal event contract for Actor ↔ Infrastructure communication
-- **`PlayError`** — the typed base class for all `@xmachines/*` runtime errors
+- **`PlayError`** — the typed base class for the runtime errors of every Play package. It extends `BaseError` of [`@xmachines/core`](../core/README.md)
 - **`NonNullableError`** — the error that a package throws when a required value is `null` or `undefined`
 - **`assertNonNullable()`** — the assertion utility that narrows `T | null | undefined` to `T`
-- **`Cleanup`**, **`asCleanup()`**, **`DISPOSE`** — the release protocol that every subscription of the ecosystem hands back
 
 These protocols implement the architectural invariants that the Play RFC defines:
 
@@ -67,7 +70,7 @@ const invalid: LoginEvent = { type: "auth.login" }; // Error!
 
 ### `PlayError`
 
-Base class for every `@xmachines/*` runtime error. Each error has a stable `scope` (the class or the module that throws it) and a stable `code` (a machine-readable identifier). Always branch on `.code` or on the subclass. Never branch on `.message`.
+Base class for the runtime errors of every Play package. It extends `BaseError` of [`@xmachines/core/errors`](../core/README.md). Each error has a stable `scope` (the class or the module that throws it) and a stable `code` (a machine-readable identifier). Always branch on `.code` or on the subclass. Never branch on `.message`.
 
 ```typescript
 import { assertNonNullable } from "@xmachines/play";
@@ -81,7 +84,7 @@ try {
 		// err.code  === "PLAY_NON_NULLABLE"
 		console.error(`Missing value: ${err.message}`);
 	} else if (err instanceof PlayError) {
-		// Any other @xmachines/* error
+		// Every other error of a Play package
 		console.error(`[${err.scope}:${err.code}] ${err.message}`);
 	} else {
 		throw err;
@@ -113,59 +116,9 @@ import { assertNonNullable } from "@xmachines/play";
 const el = assertNonNullable(document.getElementById("app"), "#app");
 ```
 
-### `Cleanup`, `asCleanup(release)`, and `DISPOSE`
-
-Every subscription of the ecosystem hands one value back: the release. `Cleanup` is that
-type. It is a function AND a `Disposable`, so one value serves both forms — the caller
-that keeps the release in a field, and the caller that gives it to a scope.
-
-```ts
-import { asCleanup, type Cleanup } from "@xmachines/play";
-
-// The explicit form. It stays correct.
-const stop = watchAtom(count, render);
-stop();
-
-// The scoped form. The scope releases it, and an exception releases it too.
-{
-	using stop = watchAtom(count, render);
-	render(count.get());
-}
-```
-
-`asCleanup` publishes a release. It gives the SAME function back with the dispose key
-added, and wraps nothing, so a caller that compares two releases or holds one in a `Set`
-sees what it saw before.
-
-```ts
-export function watchAtom<T>(atom: Readable<T>, onValue: (v: T) => void): Cleanup {
-	const subscription = atom.subscribe(() => onValue(atom.get()));
-	return asCleanup(() => subscription.unsubscribe());
-}
-```
-
-`DISPOSE` is the key that the release sits under, and a class implements the protocol
-with it:
-
-```ts
-import { DISPOSE } from "@xmachines/play";
-
-class Session {
-	close(): void {}
-	[DISPOSE](): void {
-		this.close();
-	}
-}
-```
-
-Use `DISPOSE` and not a bare `Symbol.dispose`. A bundler that downlevels `using` for a
-target below Chrome 134 emits a helper that reads
-`object[Symbol.dispose || Symbol.for("Symbol.dispose")]`, and `DISPOSE` is that same
-pair.
+### The release protocol
 
-> **The `using` FORM needs `"lib": ["ESNext"]`, and the `Cleanup` VALUE needs nothing.**
-> A consumer on a lower `lib` reads `Cleanup` as the plain `() => void` that these
-> functions returned before the protocol existed, and every call site keeps compiling.
+The release protocol moved to [`@xmachines/core/utils`](../core/README.md). A subscription of the ecosystem hands back a plain release, and `asDisposable` of that package publishes the release for a `using` scope.
 
 ---
 
@@ -173,20 +126,16 @@ pair.
 
 ### Exported from `@xmachines/play`
 
-| Export                | Kind       | Description                                                          |
-| --------------------- | ---------- | -------------------------------------------------------------------- |
-| `PlayEvent<TPayload>` | `type`     | Universal event contract — `{ type: string } & TPayload`             |
-| `assertNonNullable`   | `function` | Asserts that the value is not null. It returns the narrowed value    |
-| `Cleanup`             | `type`     | The release of a subscription — `(() => void) & Disposable`          |
-| `asCleanup`           | `function` | Publishes one release as a `Cleanup`. It changes the function itself |
-| `DISPOSE`             | `const`    | The symbol key that a release sits under                             |
-| `DisposeKey`          | `type`     | The type of that key, and `never` where the consumer omits the lib   |
+| Export                | Kind       | Description                                                       |
+| --------------------- | ---------- | ----------------------------------------------------------------- |
+| `PlayEvent<TPayload>` | `type`     | Universal event contract — `{ type: string } & TPayload`          |
+| `assertNonNullable`   | `function` | Asserts that the value is not null. It returns the narrowed value |
 
 ### Exported from `@xmachines/play/errors`
 
 | Export             | Kind    | Description                                               |
 | ------------------ | ------- | --------------------------------------------------------- |
-| `PlayError`        | `class` | The base class of every `@xmachines/*` typed error        |
+| `PlayError`        | `class` | The base class of every typed error of a Play package     |
 | `NonNullableError` | `class` | `scope: "assertNonNullable"`, `code: "PLAY_NON_NULLABLE"` |
 
 ---
@@ -197,7 +146,7 @@ pair.
 | ------------------- | ------------------ | ---------------------------------------------------- |
 | `PLAY_NON_NULLABLE` | `NonNullableError` | `assertNonNullable()` receives `null` or `undefined` |
 
-Every other `@xmachines/*` package exports its own error subclasses from its `./errors` subpath:
+Every other Play package exports its own error subclasses from its `./errors` subpath. [`@xmachines/core/errors`](../core/README.md) holds `BaseError`, the base of `PlayError`:
 
 | Package                                                      | Import path                                                         |
 | ------------------------------------------------------------ | ------------------------------------------------------------------- |
@@ -214,7 +163,7 @@ Every other `@xmachines/*` package exports its own error subclasses from its `./
 
 MIT © [Mikael Karon](mailto:mikael@karon.se)
 
-See [LICENSE](./LICENSE) for details.
+See [LICENSE](../../../LICENSE) for details.
 
 ## Modules
 

package/api/@xmachines/play/errors/classes/NonNullableError.md

@@ -2,7 +2,7 @@
 
 # Class: NonNullableError
 
-Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L112)
+Defined in: [packages/play/src/errors.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/errors.ts#L104)
 
 [@xmachines/play!index.assertNonNullable](../../index/functions/assertNonNullable.md) throws this error when a value is `null` or `undefined`.
 
@@ -35,7 +35,7 @@ try {
 new NonNullableError(message, options?): NonNullableError;
 ```
 
-Defined in: [packages/play/src/errors.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L113)
+Defined in: [packages/play/src/errors.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/errors.ts#L105)
 
 #### Parameters
 
@@ -57,10 +57,10 @@ Defined in: [packages/play/src/errors.ts:113](https://gitlab.com/xmachin-es/xmac
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                         | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`cause`](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 `PLAY_<PACKAGE>_<DESCRIPTION>`. It 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`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76) |
+| <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`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L56) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message)                 | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`name`](PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L46) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`stack`](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`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | -                                                                                                                          |
 

package/api/@xmachines/play/errors/classes/PlayError.md

@@ -2,11 +2,12 @@
 
 # Class: PlayError
 
-Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L64)
+Defined in: [packages/play/src/errors.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/errors.ts#L70)
 
-The base class of every typed runtime error of an `@xmachines/*` package.
+The base class of every typed runtime error of a Play package.
 
-`PlayError` gives each error two structured fields:
+`PlayError` extends `BaseError` of `@xmachines/core/errors`, which gives each error two
+structured fields:
 
 - `scope` — the class or the module that threw the error, for example `"RouterBridgeBase"`
 - `code` — a stable, machine-readable identifier, for example `"PLAY_ROUTER_SYNC_FAILED"`
@@ -29,7 +30,9 @@ An `@xmachines/*` package that defines typed subclasses exports them from an
 | `@xmachines/play-xstate`     | `@xmachines/play-xstate/errors`     |
 
 `PlayError` is the base of every subclass above, and it sits on the subpath with them.
-The root barrel of `@xmachines/play` exports it never: one name has one import.
+The root barrel of `@xmachines/play` exports it never: one name has one import. A
+package below the Play protocol, such as `@xmachines/core`, extends `BaseError`
+directly, so `err instanceof BaseError` matches every typed error of the workspace.
 
 ## How to catch an error by its type
 
@@ -46,7 +49,8 @@ try {
 		// err.cause  — the original error of the failed synchronization
 		reportToMonitoring(err);
 	} else if (err instanceof PlayError) {
-		// Every other @xmachines/* error
+		// Every other error of a Play package. `BaseError` of @xmachines/core/errors
+		// also matches an error of a package below the Play protocol.
 		console.error(`[${err.scope}:${err.code}] ${err.message}`);
 	} else {
 		throw err; // Throw an unknown error again
@@ -69,7 +73,7 @@ export class MyPackageError extends PlayError {
 
 ## Extends
 
-- `Error`
+- [`BaseError`](../../../core/errors/classes/BaseError.md)
 
 ## Extended by
 
@@ -111,16 +115,16 @@ new PlayError(
 ): PlayError;
 ```
 
-Defined in: [packages/play/src/errors.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L84)
+Defined in: [packages/play/src/errors.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/errors.ts#L78)
 
 #### Parameters
 
-| Parameter  | Type           | Description                                                                             |
-| ---------- | -------------- | --------------------------------------------------------------------------------------- |
-| `scope`    | `string`       | The class or the module that throws this error.                                         |
-| `code`     | `string`       | The machine-readable identifier of the error, for example `"PLAY_ROUTER_SYNC_FAILED"`.  |
-| `message`  | `string`       | The description for a person. Never match on it in your code.                           |
-| `options?` | `ErrorOptions` | The standard `ErrorOptions`. Give `{ cause: originalError }` to make a chain of errors. |
+| Parameter  | Type           | Description                                                                                                                                        |
+| ---------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `scope`    | `string`       | The class or the module that throws this error.                                                                                                    |
+| `code`     | `string`       | The machine-readable identifier of the error, for example `"PLAY_ROUTER_SYNC_FAILED"`. A Play package names a code `PLAY_<PACKAGE>_<DESCRIPTION>`. |
+| `message`  | `string`       | The description for a person. Never match on it in your code.                                                                                      |
+| `options?` | `ErrorOptions` | The standard `ErrorOptions`. Give `{ cause: originalError }` to make a chain of errors.                                                            |
 
 #### Returns
 
@@ -128,21 +132,19 @@ Defined in: [packages/play/src/errors.ts:84](https://gitlab.com/xmachin-es/xmach
 
 #### Overrides
 
-```ts
-Error.constructor;
-```
+[`BaseError`](../../../core/errors/classes/BaseError.md).[`constructor`](../../../core/errors/classes/BaseError.md#constructor)
 
 ## Properties
 
-| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from          | Defined in                                                                                                                 |
-| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.cause`           | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It 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.                                                                                                                                                  | -                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76) |
-| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.message`         | -                                                                                                                          |
-| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.name`            | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | -                       | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66) |
-| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.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. | `Error.stackTraceLimit` | -                                                                                                                          |
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                   | Defined in                                                                                                                 |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](../../../core/errors/classes/BaseError.md).[`cause`](../../../core/errors/classes/BaseError.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.                                                                                         | [`BaseError`](../../../core/errors/classes/BaseError.md).[`code`](../../../core/errors/classes/BaseError.md#property-code)                       | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L56) |
+| <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](../../../core/errors/classes/BaseError.md).[`message`](../../../core/errors/classes/BaseError.md#property-message)                 | -                                                                                                                          |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](../../../core/errors/classes/BaseError.md).[`name`](../../../core/errors/classes/BaseError.md#property-name)                       | -                                                                                                                          |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`BaseError`](../../../core/errors/classes/BaseError.md).[`scope`](../../../core/errors/classes/BaseError.md#property-scope)                     | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L46) |
+| <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](../../../core/errors/classes/BaseError.md).[`stack`](../../../core/errors/classes/BaseError.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. | [`BaseError`](../../../core/errors/classes/BaseError.md).[`stackTraceLimit`](../../../core/errors/classes/BaseError.md#property-stacktracelimit) | -                                                                                                                          |
 
 ## Methods
 
@@ -211,9 +213,7 @@ a();
 
 #### Inherited from
 
-```ts
-Error.captureStackTrace;
-```
+[`BaseError`](../../../core/errors/classes/BaseError.md).[`captureStackTrace`](../../../core/errors/classes/BaseError.md#capturestacktrace)
 
 ---
 
@@ -239,9 +239,7 @@ Indicates whether the argument provided is a built-in Error instance or not.
 
 #### Inherited from
 
-```ts
-Error.isError;
-```
+[`BaseError`](../../../core/errors/classes/BaseError.md).[`isError`](../../../core/errors/classes/BaseError.md#iserror)
 
 ---
 
@@ -270,6 +268,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 #### Inherited from
 
-```ts
-Error.prepareStackTrace;
-```
+[`BaseError`](../../../core/errors/classes/BaseError.md).[`prepareStackTrace`](../../../core/errors/classes/BaseError.md#preparestacktrace)

package/api/@xmachines/play/index/README.md

@@ -60,16 +60,8 @@ These protocols enforce the invariants below:
 
 ## Type Aliases
 
-- [Cleanup](type-aliases/Cleanup.md)
-- [DisposeKey](type-aliases/DisposeKey.md)
 - [PlayEvent](type-aliases/PlayEvent.md)
 
-## Variables
-
-- [DISPOSE](variables/DISPOSE.md)
-
 ## Functions
 
-- [asCleanup](functions/asCleanup.md)
 - [assertNonNullable](functions/assertNonNullable.md)
-- [shallowEqualExcept](functions/shallowEqualExcept.md)

package/api/@xmachines/play/index/functions/assertNonNullable.md

@@ -6,7 +6,7 @@
 function assertNonNullable<V>(value, name?): NonNullable<V>;
 ```
 
-Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/utils.ts#L39)
+Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/utils.ts#L39)
 
 Asserts that `value` is not `null` and not `undefined`, then returns it with the
 type `NonNullable<V>`. One expression therefore holds the guard and the narrowed

package/api/@xmachines/play/index/type-aliases/PlayEvent.md

@@ -6,7 +6,7 @@
 type PlayEvent<TPayload> = object & TPayload;
 ```
 
-Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/types.ts#L71)
+Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/types.ts#L71)
 
 The generic event type of the Play Architecture
 
@@ -35,7 +35,7 @@ and of the other state machine libraries.
 
 | Name   | Type     | Defined in                                                                                                               |
 | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/types.ts#L72) |
+| `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play/src/types.ts#L72) |
 
 ## Type Parameters
 

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

@@ -4,7 +4,7 @@
 
 The actor contract of the XMachines Play Architecture. It names no state machine library.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.1-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
 
 ## Installation
 

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

@@ -2,7 +2,7 @@
 
 # Interface: ActorEvent
 
-Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L38)
+Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/src/play-actor.ts#L38)
 
 The minimal shape of an event that an actor receives.
 
@@ -15,4 +15,4 @@ a union member holds no index signature, so it satisfies that default never.
 
 | Property                          | Modifier   | Type     | Defined in                                                                                                             |
 | --------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L39) |
+| <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/src/play-actor.ts#L39) |

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

@@ -2,7 +2,7 @@
 
 # Interface: PlayActor\<TSnapshot, TEvent\>
 
-Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L75)
+Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/src/play-actor.ts#L75)
 
 The actor contract of the Play Architecture. It names NO engine.
 
@@ -45,7 +45,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
 
 | Property                            | Modifier   | Type                                                        | Description                                                                                                                                                                                             | Defined in                                                                                                             |
 | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L82) |
+| <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/src/play-actor.ts#L82) |
 
 ## Methods
 
@@ -55,7 +55,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
 send(event): void;
 ```
 
-Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L90)
+Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-actor/src/play-actor.ts#L90)
 
 Sends an event to the actor.