npm - @xmachines/docs - Versions diffs - 7.0.0 → 7.2.0 - Mend

@xmachines/docs 7.0.0 → 7.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (764) hide show

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

@@ -2,7 +2,7 @@
 # Class: PlayError
-Defined in: [packages/play/src/errors.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play/src/errors.ts#L70)
+Defined in: [packages/play/src/errors.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play/src/errors.ts#L70)
 The base class of every typed runtime error of a Play package.
@@ -117,7 +117,7 @@ new PlayError(
 ): PlayError;
 ```
-Defined in: [packages/play/src/errors.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play/src/errors.ts#L78)
+Defined in: [packages/play/src/errors.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play/src/errors.ts#L78)
 #### Parameters
@@ -138,15 +138,15 @@ Defined in: [packages/play/src/errors.ts:78](https://gitlab.com/xmachin-es/xmach
 ## Properties
-| 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/v7.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/v7.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) | -                                                                                                                          |
+| 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/docs-v7.2.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/docs-v7.2.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

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

@@ -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/v7.0.0/packages/play/src/utils.ts#L39)
+Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.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
@@ -22,9 +22,9 @@ second variable and no `as` cast.
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `V`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-v"></a> `V` |
 ## Parameters

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

@@ -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/v7.0.0/packages/play/src/types.ts#L71)
+Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play/src/types.ts#L71)
 The generic event type of the Play Architecture
@@ -31,17 +31,17 @@ and of the other state machine libraries.
 - A domain event: `{ type: 'auth.login', userId: '123' }`
 - Your own event: `{ type: 'form.submit', data: {...} }`
-## Type Declaration
+## Type Parameters
-| Name   | Type     | Defined in                                                                                                               |
-| ------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play/src/types.ts#L72) |
+| Type Parameter                                                                            | Default type                    | Description                                                       |
+| ----------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------- |
+| <a id="type-parameter-tpayload"></a> `TPayload` _extends_ `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> | The fields after `type`. The default is `Record<string, unknown>` |
-## Type Parameters
+## Type Declaration
-| Type Parameter                                       | Default type                    | Description                                                       |
-| ---------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------- |
-| `TPayload` _extends_ `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> | The fields after `type`. The default is `Record<string, unknown>` |
+| Name   | Type     | Defined in                                                                                                                    |
+| ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play/src/types.ts#L72) |
 ## Examples

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

@@ -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-7.0.0-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-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
 ## Installation
@@ -62,7 +62,8 @@ import type { Atom } from "@xmachines/play-atom";
 type Snapshot = { readonly value: string };
 type AuthEvent =
-	{ readonly type: "auth.login"; readonly username: string } | { readonly type: "auth.logout" };
+	| { readonly type: "auth.login"; readonly username: string }
+	| { readonly type: "auth.logout" };
 class AuthActor implements PlayActor<Snapshot, AuthEvent> {
 	readonly state = createAtom<Snapshot>({ value: "guest" });
@@ -85,7 +86,8 @@ import { createAtom } from "@xmachines/play-atom";
 type Snapshot = { readonly value: string };
 type AuthEvent =
-	{ readonly type: "auth.login"; readonly username: string } | { readonly type: "auth.logout" };
+	| { readonly type: "auth.login"; readonly username: string }
+	| { readonly type: "auth.logout" };
 const actor: PlayActor<Snapshot, AuthEvent> = {
 	state: createAtom<Snapshot>({ value: "guest" }),

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

@@ -2,7 +2,7 @@
 # Interface: ActorEvent
-Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-actor/src/play-actor.ts#L38)
+Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-actor/src/play-actor.ts#L38)
 The minimal shape of an event that an actor receives.
@@ -13,6 +13,6 @@ a union member holds no index signature, so it satisfies that default never.
 ## Properties
-| 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/v7.0.0/packages/play-actor/src/play-actor.ts#L39) |
+| 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/docs-v7.2.0/packages/play-actor/src/play-actor.ts#L39) |

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

@@ -2,7 +2,7 @@
 # Interface: PlayActor\<TSnapshot, TEvent\>
-Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-actor/src/play-actor.ts#L75)
+Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-actor/src/play-actor.ts#L75)
 The actor contract of the Play Architecture. It names NO engine.
@@ -36,16 +36,16 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
 ## Type Parameters
-| Type Parameter                                   | Default type                  | Description                                                                        |
-| ------------------------------------------------ | ----------------------------- | ---------------------------------------------------------------------------------- |
-| `TSnapshot`                                      | `unknown`                     | The type of the snapshot that `state` holds, for example `SnapshotFrom<TMachine>`. |
-| `TEvent` _extends_ [`ActorEvent`](ActorEvent.md) | [`ActorEvent`](ActorEvent.md) | The event union that `send` accepts, for example `EventFromLogic<TMachine>`.       |
+| Type Parameter                                                                      | Default type                  | Description                                                                        |
+| ----------------------------------------------------------------------------------- | ----------------------------- | ---------------------------------------------------------------------------------- |
+| <a id="type-parameter-tsnapshot"></a> `TSnapshot`                                   | `unknown`                     | The type of the snapshot that `state` holds, for example `SnapshotFrom<TMachine>`. |
+| <a id="type-parameter-tevent"></a> `TEvent` _extends_ [`ActorEvent`](ActorEvent.md) | [`ActorEvent`](ActorEvent.md) | The event union that `send` accepts, for example `EventFromLogic<TMachine>`.       |
 ## Properties
-| 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/v7.0.0/packages/play-actor/src/play-actor.ts#L82) |
+| 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/docs-v7.2.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/v7.0.0/packages/play-actor/src/play-actor.ts#L90)
+Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-actor/src/play-actor.ts#L90)
 Sends an event to the actor.

package/api/@xmachines/play-atom/README.md CHANGED Viewed

@@ -4,7 +4,7 @@
 The atom primitives for XMachines. They give the Play Architecture fine-grained reactive state. The primitives propagate state without a glitch and without a subscription of the consumer.
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-atom)
+[![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-atom)
 ## Installation

package/api/@xmachines/play-atom/functions/watchAtom.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function watchAtom<T>(atom, onValue): () => void;
 ```
-Defined in: [watch-atom.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/watch-atom.ts#L57)
+Defined in: [watch-atom.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/watch-atom.ts#L57)
 Subscribes to one atom, and coalesces the notifications into one microtask.
@@ -47,9 +47,9 @@ using stop = asDisposable(watchAtom(count, render));
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Parameters

package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: AsyncAtomOptions
-Defined in: [types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L168)
+Defined in: [types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L168)
 What `createAsyncAtom` gives its getter
@@ -11,6 +11,6 @@ stale answer reaches the atom never. Pass it to `fetch`, and the request stops w
 ## Properties
-| Property                              | Modifier   | Type          | Description                                                  | Defined in                                                                                                    |
-| ------------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
-| <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L170) |
+| Property                              | Modifier   | Type          | Description                                                  | Defined in                                                                                                         |
+| ------------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L170) |

package/api/@xmachines/play-atom/interfaces/Atom.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: Atom\<T\>
-Defined in: [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L117)
+Defined in: [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L117)
 The writable atom. It holds one reactive value
@@ -28,9 +28,9 @@ name.set((previous) => previous.toUpperCase()); // "BOB"
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Methods
@@ -40,7 +40,7 @@ name.set((previous) => previous.toUpperCase()); // "BOB"
 get(): T;
 ```
-Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L59)
+Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -60,7 +60,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0
 set(fn): void;
 ```
-Defined in: [types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L119)
+Defined in: [types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L119)
 Sets the value of the atom from the previous value.
@@ -80,7 +80,7 @@ Sets the value of the atom from the previous value.
 set(value): void;
 ```
-Defined in: [types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L121)
+Defined in: [types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L121)
 Sets the value of the atom.
@@ -104,7 +104,7 @@ Sets the value of the atom.
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L60)
+Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -130,7 +130,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L61)
+Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L61)
 ##### Parameters

package/api/@xmachines/play-atom/interfaces/AtomObserver.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: AtomObserver\<T\>
-Defined in: [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L34)
+Defined in: [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L34)
 The observer of an atom, in the object form
@@ -12,14 +12,14 @@ consumers that adapt an atom to an observable.
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Properties
-| Property                                   | Type                | Defined in                                                                                                  |
-| ------------------------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------- |
-| <a id="property-complete"></a> `complete?` | () => `void`        | [types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L37) |
-| <a id="property-error"></a> `error?`       | (`error`) => `void` | [types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L36) |
-| <a id="property-next"></a> `next?`         | (`value`) => `void` | [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L35) |
+| Property                                   | Type                | Defined in                                                                                                       |
+| ------------------------------------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| <a id="property-complete"></a> `complete?` | () => `void`        | [types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L37) |
+| <a id="property-error"></a> `error?`       | (`error`) => `void` | [types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L36) |
+| <a id="property-next"></a> `next?`         | (`value`) => `void` | [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L35) |

package/api/@xmachines/play-atom/interfaces/AtomOptions.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: AtomOptions\<T\>
-Defined in: [types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L147)
+Defined in: [types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L147)
 The options of `createAtom`
@@ -22,12 +22,12 @@ const point = createAtom(
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Properties
-| Property                                 | Type                              | Defined in                                                                                                    |
-| ---------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L148) |
+| Property                                 | Type                              | Defined in                                                                                                         |
+| ---------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L148) |

package/api/@xmachines/play-atom/interfaces/AtomSubscription.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: AtomSubscription
-Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L23)
+Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L23)
 The release of one subscription
@@ -16,7 +16,7 @@ The release of one subscription
 unsubscribe(): void;
 ```
-Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L24)
+Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L24)
 #### Returns

package/api/@xmachines/play-atom/interfaces/BaseAtom.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: BaseAtom\<T\>
-Defined in: [types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L74)
+Defined in: [types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L74)
 The common base of a writable atom and a computed atom
@@ -20,9 +20,9 @@ both kinds.
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Methods
@@ -32,7 +32,7 @@ both kinds.
 get(): T;
 ```
-Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L59)
+Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -52,7 +52,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L60)
+Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -78,7 +78,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L61)
+Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L61)
 ##### Parameters

package/api/@xmachines/play-atom/interfaces/CreateAtom.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: CreateAtom()
-Defined in: [create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/create-atom.ts#L33)
+Defined in: [create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/create-atom.ts#L33)
 The two forms of `createAtom`
@@ -22,7 +22,7 @@ because `get` tracked the edge already.
 CreateAtom<T>(getValue, options?): ReadonlyAtom<T>;
 ```
-Defined in: [create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/create-atom.ts#L34)
+Defined in: [create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/create-atom.ts#L34)
 The two forms of `createAtom`
@@ -38,9 +38,9 @@ because `get` tracked the edge already.
 ### Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ### Parameters
@@ -59,7 +59,7 @@ because `get` tracked the edge already.
 CreateAtom<T>(initialValue, options?): Atom<T>;
 ```
-Defined in: [create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/create-atom.ts#L35)
+Defined in: [create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/create-atom.ts#L35)
 The two forms of `createAtom`
@@ -75,9 +75,9 @@ because `get` tracked the edge already.
 ### Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                      |
+| ----------------------------------- |
+| <a id="type-parameter-t-1"></a> `T` |
 ### Parameters

package/api/@xmachines/play-atom/interfaces/Readable.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: Readable\<T\>
-Defined in: [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L58)
+Defined in: [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L58)
 The read side of an atom
@@ -28,9 +28,9 @@ show(createAtom("ready")); // "ready"
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Methods
@@ -40,7 +40,7 @@ show(createAtom("ready")); // "ready"
 get(): T;
 ```
-Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L59)
+Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -56,7 +56,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L60)
+Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -78,7 +78,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L61)
+Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L61)
 ##### Parameters

package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # Interface: ReadonlyAtom\<T\>
-Defined in: [types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L97)
+Defined in: [types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L97)
 The computed atom. It evaluates late, and it memoizes the result
@@ -31,9 +31,9 @@ console.log(doubled.get()); // 10 (from the memory, with no new computation)
 ## Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 ## Methods
@@ -43,7 +43,7 @@ console.log(doubled.get()); // 10 (from the memory, with no new computation)
 get(): T;
 ```
-Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L59)
+Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -63,7 +63,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L60)
+Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -89,7 +89,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-atom/src/types.ts#L61)
+Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-atom/src/types.ts#L61)
 ##### Parameters