@xmachines/docs 6.1.0 → 7.1.0

package/README.md

@@ -2,7 +2,7 @@
 
 > Documentation, guides, RFCs, and generated API reference for XMachines.
 
-[![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/docs)
+[![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/docs)
 
 ## Overview
 
@@ -28,7 +28,7 @@ pnpm add @xmachines/docs
 
 The default export of the package is its own module URL. Use it to resolve documentation assets at run time:
 
-```typescript
+```typescript fragment
 import docsUrl from "@xmachines/docs";
 // docsUrl is the resolved URL of the docs package entry point
 ```
@@ -37,7 +37,7 @@ import docsUrl from "@xmachines/docs";
 
 The package exports every documentation directory:
 
-```typescript
+```typescript fragment
 // Access RFC files
 import playRfc from "@xmachines/docs/rfc/play.md";
 
@@ -118,7 +118,7 @@ The documented packages:
 
 - [`@xmachines/play`](../play/README.md) — Core protocols (`PlayEvent`, `PlayError`)
 - [`@xmachines/play-actor`](../play-actor/README.md) — `PlayActor`
-- [`@xmachines/play-view`](../play-view/README.md) — `Viewable`, `PlaySpec`, the view store lifecycle
+- [`@xmachines/play-view`](../play-view/README.md) — `Viewable`, `PlaySpec`, the view session
 - [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives, `watchAtom`
 - [`@xmachines/core`](../core/README.md) — `BaseError` on `/errors`, the release protocol (`asDisposable`, `DISPOSE`) and helpers on `/utils`, a key-value cache on `/cache`
 - [`@xmachines/play-router`](../play-router/README.md) — `RouterBridgeBase`, `RouteMap`, `Routable`

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

@@ -4,7 +4,7 @@
 
 The base of the XMachines packages: the error base class, the release protocol, and a cache.
 
-[![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/core)
+[![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/core)
 
 Code that more than one `@xmachines/*` package can use, and that belongs to no layer of the Play Architecture. The package reads no workspace package. [`@xmachines/play`](../play/README.md) reads it, and so can every package above the protocol layer.
 
@@ -38,6 +38,8 @@ pnpm add @xmachines/core
 ```ts
 import { BaseError } from "@xmachines/core/errors";
 
+declare function start(): void; // your code, which can throw
+
 try {
 	start();
 } catch (err) {
@@ -58,9 +60,12 @@ A package below the Play protocol extends `BaseError` directly. This package thr
 `asDisposable` gives the SAME function back with the dispose key added. Nothing wraps it, so a caller that runs the release keeps that code:
 
 ```ts
-import { watchAtom } from "@xmachines/play-atom";
+import { createAtom, watchAtom } from "@xmachines/play-atom";
 import { asDisposable } from "@xmachines/core/utils";
 
+const count = createAtom(0);
+const render = (value: number) => console.log(value);
+
 // The explicit form.
 const stop = watchAtom(count, render);
 stop();

package/api/@xmachines/core/cache/functions/createLruCache.md

@@ -6,7 +6,7 @@
 function createLruCache<V>(maxSize?): KeyValueCache<V>;
 ```
 
-Defined in: [packages/core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/cache.ts#L54)
+Defined in: [packages/core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/cache.ts#L54)
 
 Builds a cache that forgets its least recently used entries.
 
@@ -25,15 +25,15 @@ A stored `undefined` reads as a miss. Store `null` for "no value".
 
 ## Type Parameters
 
-| Type Parameter |
-| -------------- |
-| `V`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-v"></a> `V` |
 
 ## Parameters
 
-| Parameter | Type     | Default value | Description                                                                                                                                                                                                          |
-| --------- | -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `maxSize` | `number` | `500`         | The number of entries that `recent` holds. It is `1` at the least, and the default is `500`. A value that is not a finite number reads as the default, so a cache with no eviction at all cannot happen by accident. |
+| Parameter  | Type     | Default value | Description                                                                                                                                                                                                          |
+| ---------- | -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `maxSize?` | `number` | `500`         | The number of entries that `recent` holds. It is `1` at the least, and the default is `500`. A value that is not a finite number reads as the default, so a cache with no eviction at all cannot happen by accident. |
 
 ## Returns
 

package/api/@xmachines/core/cache/interfaces/KeyValueCache.md

@@ -2,7 +2,7 @@
 
 # Interface: KeyValueCache\<V\>
 
-Defined in: [packages/core/src/cache.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/cache.ts#L17)
+Defined in: [packages/core/src/cache.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/cache.ts#L17)
 
 What a reader needs from a cache: a read and a write, both by a string key.
 
@@ -11,9 +11,9 @@ reader that computes the value again for an entry that is absent.
 
 ## Type Parameters
 
-| Type Parameter |
-| -------------- |
-| `V`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-v"></a> `V` |
 
 ## Methods
 
@@ -23,7 +23,7 @@ reader that computes the value again for an entry that is absent.
 get(key): V | undefined;
 ```
 
-Defined in: [packages/core/src/cache.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/cache.ts#L19)
+Defined in: [packages/core/src/cache.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/cache.ts#L19)
 
 Reads one entry, or `undefined` when the cache holds none for the key.
 
@@ -45,7 +45,7 @@ Reads one entry, or `undefined` when the cache holds none for the key.
 set(key, value): void;
 ```
 
-Defined in: [packages/core/src/cache.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/cache.ts#L21)
+Defined in: [packages/core/src/cache.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/cache.ts#L21)
 
 Writes one entry.
 

package/api/@xmachines/core/errors/classes/BaseError.md

@@ -2,7 +2,7 @@
 
 # Class: BaseError
 
-Defined in: [packages/core/src/errors.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L44)
+Defined in: [packages/core/src/errors.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L44)
 
 The base class of every typed runtime error of an `@xmachines/*` package.
 
@@ -62,7 +62,7 @@ new BaseError(
 ): BaseError;
 ```
 
-Defined in: [packages/core/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L64)
+Defined in: [packages/core/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L64)
 
 #### Parameters
 
@@ -79,21 +79,19 @@ Defined in: [packages/core/src/errors.ts:64](https://gitlab.com/xmachin-es/xmach
 
 #### Overrides
 
-```ts
-Error.constructor;
-```
+`Error.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 `<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.                                                                                         | -                       | [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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `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 `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | -                       | [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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `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` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `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 `<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.                                                                                         | -                       | [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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `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 `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | -                       | [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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `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` | -                                                                                                                               |
 
 ## Methods
 
@@ -162,9 +160,7 @@ a();
 
 #### Inherited from
 
-```ts
-Error.captureStackTrace;
-```
+`Error.captureStackTrace`
 
 ---
 
@@ -190,9 +186,7 @@ Indicates whether the argument provided is a built-in Error instance or not.
 
 #### Inherited from
 
-```ts
-Error.isError;
-```
+`Error.isError`
 
 ---
 
@@ -221,6 +215,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 #### Inherited from
 
-```ts
-Error.prepareStackTrace;
-```
+`Error.prepareStackTrace`

package/api/@xmachines/core/errors/classes/DisposeConflictError.md

@@ -2,7 +2,7 @@
 
 # Class: DisposeConflictError
 
-Defined in: [packages/core/src/errors.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L80)
+Defined in: [packages/core/src/errors.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L80)
 
 [asDisposable](../../utils/functions/asDisposable.md) throws this error when the target
 has a dispose member already, and that member is not the named release.
@@ -23,7 +23,7 @@ call, and do not catch it in production code.
 new DisposeConflictError(message, options?): DisposeConflictError;
 ```
 
-Defined in: [packages/core/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L81)
+Defined in: [packages/core/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/errors.ts#L81)
 
 #### Parameters
 
@@ -42,15 +42,15 @@ Defined in: [packages/core/src/errors.ts:81](https://gitlab.com/xmachin-es/xmach
 
 ## Properties
 
-| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                         | Defined in                                                                                                                 |
-| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`cause`](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`](BaseError.md).[`code`](BaseError.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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`message`](BaseError.md#property-message)                 | -                                                                                                                          |
-| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`name`](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`](BaseError.md).[`scope`](BaseError.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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`stack`](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`](BaseError.md).[`stackTraceLimit`](BaseError.md#property-stacktracelimit) | -                                                                                                                          |
+| Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                         | Defined in                                                                                                                      |
+| ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`cause`](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`](BaseError.md).[`code`](BaseError.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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`message`](BaseError.md#property-message)                 | -                                                                                                                               |
+| <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`name`](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`](BaseError.md).[`scope`](BaseError.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`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`BaseError`](BaseError.md).[`stack`](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`](BaseError.md).[`stackTraceLimit`](BaseError.md#property-stacktracelimit) | -                                                                                                                               |
 
 ## Methods
 

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

@@ -8,7 +8,7 @@
 function asDisposable<F>(release): F & DisposeMember;
 ```
 
-Defined in: [packages/core/src/utils/disposable.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/disposable.ts#L126)
+Defined in: [packages/core/src/utils/disposable.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/disposable.ts#L126)
 
 Makes one release function a `Disposable`. The function is its own release.
 
@@ -54,9 +54,9 @@ constraint. Write the release inline, or type it, and the bound applies.
 
 ### Type Parameters
 
-| Type Parameter                            |
-| ----------------------------------------- |
-| `F` _extends_ () => `void` \| `undefined` |
+| Type Parameter                                                          |
+| ----------------------------------------------------------------------- |
+| <a id="type-parameter-f"></a> `F` _extends_ () => `void` \| `undefined` |
 
 ### Parameters
 
@@ -85,7 +85,7 @@ dispose key holds no member yet.
 function asDisposable<T, R>(target, release): T & DisposeMember;
 ```
 
-Defined in: [packages/core/src/utils/disposable.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/disposable.ts#L157)
+Defined in: [packages/core/src/utils/disposable.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/disposable.ts#L157)
 
 Makes one object a `Disposable`, with a release that the caller names.
 
@@ -103,10 +103,10 @@ must be synchronous.
 
 ### Type Parameters
 
-| Type Parameter                      |
-| ----------------------------------- |
-| `T` _extends_ `object`              |
-| `R` _extends_ `void` \| `undefined` |
+| Type Parameter                                                    |
+| ----------------------------------------------------------------- |
+| <a id="type-parameter-t"></a> `T` _extends_ `object`              |
+| <a id="type-parameter-r"></a> `R` _extends_ `void` \| `undefined` |
 
 ### Parameters
 

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

@@ -6,7 +6,7 @@
 function createNullRecord<V>(): Record<string, V>;
 ```
 
-Defined in: [packages/core/src/utils/null-record.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/null-record.ts#L21)
+Defined in: [packages/core/src/utils/null-record.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/null-record.ts#L21)
 
 Builds an empty record with no prototype.
 
@@ -19,9 +19,9 @@ store.
 
 ## Type Parameters
 
-| Type Parameter |
-| -------------- |
-| `V`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-v"></a> `V` |
 
 ## Returns
 

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

@@ -6,7 +6,7 @@
 function createWarnOnce(): (anchor, message) => void;
 ```
 
-Defined in: [packages/core/src/utils/warn-once.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/warn-once.ts#L27)
+Defined in: [packages/core/src/utils/warn-once.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/warn-once.ts#L27)
 
 Builds a function that writes one warning for each anchor object, and no more.
 

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

@@ -6,7 +6,7 @@
 function describeValue(value): string;
 ```
 
-Defined in: [packages/core/src/utils/describe-value.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/describe-value.ts#L53)
+Defined in: [packages/core/src/utils/describe-value.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/describe-value.ts#L53)
 
 Describes an unknown value for the message of an error, and throws nothing itself.
 

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

@@ -6,7 +6,7 @@
 function isError(value): value is Error;
 ```
 
-Defined in: [packages/core/src/utils/is-error.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/is-error.ts#L29)
+Defined in: [packages/core/src/utils/is-error.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/is-error.ts#L29)
 
 Tells if a value is an `Error`, by its identity or by its brand.
 

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

@@ -6,7 +6,7 @@
 function isThenable<T>(value): value is PromiseLike<T>;
 ```
 
-Defined in: [packages/core/src/utils/is-thenable.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/is-thenable.ts#L20)
+Defined in: [packages/core/src/utils/is-thenable.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/is-thenable.ts#L20)
 
 Tells if a value is a thenable, so that the caller can wait for it.
 
@@ -17,9 +17,9 @@ applies too.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| -------------- | ------------ |
-| `T`            | `unknown`    |
+| Type Parameter                    | Default type |
+| --------------------------------- | ------------ |
+| <a id="type-parameter-t"></a> `T` | `unknown`    |
 
 ## Parameters
 

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

@@ -6,7 +6,7 @@
 function releaseQuietly(release, onFailure): void;
 ```
 
-Defined in: [packages/core/src/utils/release-quietly.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/release-quietly.ts#L23)
+Defined in: [packages/core/src/utils/release-quietly.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/release-quietly.ts#L23)
 
 Runs one release, and it contains a failure of that release.
 

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

@@ -6,7 +6,7 @@
 function rethrowLater(error): void;
 ```
 
-Defined in: [packages/core/src/utils/rethrow-later.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/rethrow-later.ts#L28)
+Defined in: [packages/core/src/utils/rethrow-later.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/rethrow-later.ts#L28)
 
 Throws an error again from a microtask of its own, and returns at once.
 

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

@@ -6,7 +6,7 @@
 function safeString(value): string;
 ```
 
-Defined in: [packages/core/src/utils/describe-value.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/describe-value.ts#L19)
+Defined in: [packages/core/src/utils/describe-value.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/describe-value.ts#L19)
 
 Converts an unknown value into a string, and it trusts that value not.
 

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

@@ -6,7 +6,7 @@
 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.1.0/packages/core/src/utils/shallow-equal.ts#L25)
+Defined in: [packages/core/src/utils/shallow-equal.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.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.

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

@@ -6,7 +6,7 @@
 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.1.0/packages/core/src/utils/disposable.ts#L33)
+Defined in: [packages/core/src/utils/disposable.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/disposable.ts#L33)
 
 The dispose key of the ambient library, and `never` where the consumer omits it.
 

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

@@ -6,7 +6,7 @@
 type DisposeMember = { [Key in DisposeKey]: () => void };
 ```
 
-Defined in: [packages/core/src/utils/disposable.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/disposable.ts#L43)
+Defined in: [packages/core/src/utils/disposable.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/disposable.ts#L43)
 
 The dispose member of a `Disposable`, and no member where the consumer omits the library.
 

package/api/@xmachines/core/utils/variables/DISPOSE.md

@@ -6,7 +6,7 @@
 const DISPOSE: DisposeKey;
 ```
 
-Defined in: [packages/core/src/utils/disposable.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/utils/disposable.ts#L71)
+Defined in: [packages/core/src/utils/disposable.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/core/src/utils/disposable.ts#L71)
 
 The key that a release is stored under.
 

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

@@ -4,7 +4,7 @@
 
 > 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-6.1.0-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-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play)
 
 ---
 
@@ -65,7 +65,8 @@ const loginEvent: LoginEvent = {
 };
 
 // TypeScript error: missing required field
-const invalid: LoginEvent = { type: "auth.login" }; // Error!
+// @ts-expect-error -- `userId` and `timestamp` are missing
+const invalid: LoginEvent = { type: "auth.login" };
 ```
 
 ### `PlayError`
@@ -76,8 +77,10 @@ Base class for the runtime errors of every Play package. It extends `BaseError`
 import { assertNonNullable } from "@xmachines/play";
 import { NonNullableError, PlayError } from "@xmachines/play/errors";
 
+const settings = new Map<string, string>([["apiUrl", "https://api.example.com"]]);
+
 try {
-	assertNonNullable(document.getElementById("app"), "#app");
+	assertNonNullable(settings.get("timeout"), "timeout");
 } catch (err) {
 	if (err instanceof NonNullableError) {
 		// err.scope === "assertNonNullable"
@@ -112,8 +115,10 @@ The assertion utility returns `value` with the type `NonNullable<V>`, or it thro
 ```typescript
 import { assertNonNullable } from "@xmachines/play";
 
-// DOM element lookup — no intermediate variable or `!` needed:
-const el = assertNonNullable(document.getElementById("app"), "#app");
+const settings = new Map<string, string>([["apiUrl", "https://api.example.com"]]);
+
+// A lookup that can miss — no intermediate variable or `!` needed:
+const apiUrl = assertNonNullable(settings.get("apiUrl"), "apiUrl");
 ```
 
 ### The release protocol

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

@@ -2,7 +2,7 @@
 
 # Class: NonNullableError
 
-Defined in: [packages/play/src/errors.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play/src/errors.ts#L104)
+Defined in: [packages/play/src/errors.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.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:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play/src/errors.ts#L105)
+Defined in: [packages/play/src/errors.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play/src/errors.ts#L105)
 
 #### Parameters
 
@@ -54,15 +54,15 @@ Defined in: [packages/play/src/errors.ts:105](https://gitlab.com/xmachin-es/xmac
 
 ## Properties
 
-| 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 `<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.1.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 `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](PlayError.md).[`scope`](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`](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) | -                                                                                                                          |
+| 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 `<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/docs-v7.1.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 `"asDisposable"`.                                                                                                                                                                                                                                                                                                                                                                      | [`PlayError`](PlayError.md).[`scope`](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`](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) | -                                                                                                                               |
 
 ## Methods