npm - @xmachines/docs - Versions diffs - 5.0.1 → 5.0.2 - Mend

@xmachines/docs 5.0.1 → 5.0.2

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 (519) hide show

package/README.md CHANGED Viewed

@@ -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-5.0.1-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-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/docs)
 ## Overview

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

@@ -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-5.0.1-blue)](https://www.npmjs.com/package/@xmachines/play)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play)
 ---
@@ -214,7 +214,7 @@ Every other `@xmachines/*` package exports its own error subclasses from its `./
 MIT © [Mikael Karon](mailto:mikael@karon.se)
-See [LICENSE](./LICENSE) for details.
+See [LICENSE](../../../LICENSE) for details.
 ## Modules

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

@@ -2,7 +2,7 @@
 # Class: NonNullableError
-Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L112)
+Defined in: [packages/play/src/errors.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L112)
 [@xmachines/play!index.assertNonNullable](../../index/functions/assertNonNullable.md) throws this error when a value is `null` or `undefined`.
@@ -35,7 +35,7 @@ try {
 new NonNullableError(message, options?): NonNullableError;
 ```
-Defined in: [packages/play/src/errors.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L113)
+Defined in: [packages/play/src/errors.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L113)
 #### Parameters
@@ -57,10 +57,10 @@ Defined in: [packages/play/src/errors.ts:113](https://gitlab.com/xmachin-es/xmac
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                         | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`cause`](PlayError.md#property-cause)                     | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code)                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message)                 | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`name`](PlayError.md#property-name)                       | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope)                     | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack)                     | -                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | -                                                                                                                          |

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

@@ -2,7 +2,7 @@
 # Class: PlayError
-Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L64)
+Defined in: [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L64)
 The base class of every typed runtime error of an `@xmachines/*` package.
@@ -111,7 +111,7 @@ new PlayError(
 ): PlayError;
 ```
-Defined in: [packages/play/src/errors.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L84)
+Defined in: [packages/play/src/errors.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L84)
 #### Parameters
@@ -137,10 +137,10 @@ Error.constructor;
 | Property                                                | Modifier   | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from          | Defined in                                                                                                                 |
 | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
 | <a id="property-cause"></a> `cause?`                    | `public`   | `unknown` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.cause`           | -                                                                                                                          |
-| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | -                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76) |
+| <a id="property-code"></a> `code`                       | `readonly` | `string`  | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass.                                                                                                                                                  | -                       | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76) |
 | <a id="property-message"></a> `message`                 | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.message`         | -                                                                                                                          |
 | <a id="property-name"></a> `name`                       | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.name`            | -                                                                                                                          |
-| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | -                       | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66) |
+| <a id="property-scope"></a> `scope`                     | `readonly` | `string`  | The class or the module that threw this error, for example `"RouterBridgeBase"`.                                                                                                                                                                                                                                                                                                                                                                  | -                       | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66) |
 | <a id="property-stack"></a> `stack?`                    | `public`   | `string`  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `Error.stack`           | -                                                                                                                          |
 | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static`   | `number`  | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | -                                                                                                                          |

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

@@ -6,7 +6,7 @@
 function asCleanup<R>(release): Cleanup;
 ```
-Defined in: [packages/play/src/disposable.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L149)
+Defined in: [packages/play/src/disposable.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/disposable.ts#L149)
 Makes one release function serve as a [Cleanup](../type-aliases/Cleanup.md).

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

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

@@ -6,7 +6,7 @@
 function shallowEqualExcept(a, b, except?): boolean;
 ```
-Defined in: [packages/play/src/utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/utils.ts#L59)
+Defined in: [packages/play/src/utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/utils.ts#L59)
 The shallow equality of the own keys, with `Object.is`. It can ignore one key on
 both sides.

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

@@ -6,7 +6,7 @@
 type Cleanup = () => void & { [Key in DisposeKey]: () => void };
 ```
-Defined in: [packages/play/src/disposable.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L66)
+Defined in: [packages/play/src/disposable.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/disposable.ts#L66)
 The release of a subscription. A caller runs it, or a scope releases it.

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

@@ -6,7 +6,7 @@
 type DisposeKey = SymbolConstructor extends object ? Key : never;
 ```
-Defined in: [packages/play/src/disposable.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L34)
+Defined in: [packages/play/src/disposable.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/disposable.ts#L34)
 The dispose key of the ambient library, and `never` where the consumer omits it.

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

package/api/@xmachines/play/index/variables/DISPOSE.md CHANGED Viewed

@@ -6,7 +6,7 @@
 const DISPOSE: DisposeKey;
 ```
-Defined in: [packages/play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L94)
+Defined in: [packages/play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/disposable.ts#L94)
 The key that a release is stored under.

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-5.0.1-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
 ## Installation

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/v5.0.1/packages/play-actor/src/play-actor.ts#L38)
+Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/src/play-actor.ts#L38)
 The minimal shape of an event that an actor receives.
@@ -15,4 +15,4 @@ a union member holds no index signature, so it satisfies that default never.
 | Property                          | Modifier   | Type     | Defined in                                                                                                             |
 | --------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L39) |
+| <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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/v5.0.1/packages/play-actor/src/play-actor.ts#L75)
+Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/src/play-actor.ts#L75)
 The actor contract of the Play Architecture. It names NO engine.
@@ -45,7 +45,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
 | Property                            | Modifier   | Type                                                        | Description                                                                                                                                                                                             | Defined in                                                                                                             |
 | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L82) |
+| <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/src/play-actor.ts#L82) |
 ## Methods
@@ -55,7 +55,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
 send(event): void;
 ```
-Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/src/play-actor.ts#L90)
+Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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-5.0.1-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-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-atom)
 ## Installation
@@ -193,7 +193,7 @@ XMachines 5.0.0 moved the engine from `@xstate/store` 3 to 4. A computed getter
 ## License
-MIT — see [LICENSE](LICENSE).
+MIT — see [LICENSE](../../../LICENSE).
 The atom primitives of the XMachines Play Architecture

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

@@ -6,7 +6,7 @@
 function watchAtom<T>(atom, onValue): Cleanup;
 ```
-Defined in: [play-atom/src/watch-atom.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/watch-atom.ts#L58)
+Defined in: [play-atom/src/watch-atom.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/watch-atom.ts#L58)
 Subscribes to one atom, and coalesces the notifications into one microtask.

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

@@ -2,7 +2,7 @@
 # Interface: AsyncAtomOptions
-Defined in: [play-atom/src/types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L168)
+Defined in: [play-atom/src/types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L168)
 What `createAsyncAtom` gives its getter
@@ -13,4 +13,4 @@ stale answer reaches the atom never. Pass it to `fetch`, and the request stops w
 | Property                              | Modifier   | Type          | Description                                                  | Defined in                                                                                                                  |
 | ------------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [play-atom/src/types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L170) |
+| <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [play-atom/src/types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L117)
+Defined in: [play-atom/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L117)
 The writable atom. It holds one reactive value
@@ -40,7 +40,7 @@ name.set((previous) => previous.toUpperCase()); // "BOB"
 get(): T;
 ```
-Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L59)
+Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -60,7 +60,7 @@ Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-
 set(fn): void;
 ```
-Defined in: [play-atom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L119)
+Defined in: [play-atom/src/types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L121)
+Defined in: [play-atom/src/types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L60)
+Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -130,7 +130,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L61)
+Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L34)
+Defined in: [play-atom/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L34)
 The observer of an atom, in the object form
@@ -20,6 +20,6 @@ consumers that adapt an atom to an observable.
 | Property                                   | Type                | Defined in                                                                                                                |
 | ------------------------------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-complete"></a> `complete?` | () => `void`        | [play-atom/src/types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L37) |
-| <a id="property-error"></a> `error?`       | (`error`) => `void` | [play-atom/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L36) |
-| <a id="property-next"></a> `next?`         | (`value`) => `void` | [play-atom/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L35) |
+| <a id="property-complete"></a> `complete?` | () => `void`        | [play-atom/src/types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L37) |
+| <a id="property-error"></a> `error?`       | (`error`) => `void` | [play-atom/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L36) |
+| <a id="property-next"></a> `next?`         | (`value`) => `void` | [play-atom/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L147)
+Defined in: [play-atom/src/types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L147)
 The options of `createAtom`
@@ -30,4 +30,4 @@ const point = createAtom(
 | Property                                 | Type                              | Defined in                                                                                                                  |
 | ---------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [play-atom/src/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L148) |
+| <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [play-atom/src/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L23)
+Defined in: [play-atom/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L24)
+Defined in: [play-atom/src/types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L74)
+Defined in: [play-atom/src/types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L74)
 The common base of a writable atom and a computed atom
@@ -32,7 +32,7 @@ both kinds.
 get(): T;
 ```
-Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L59)
+Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -52,7 +52,7 @@ Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L60)
+Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -78,7 +78,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L61)
+Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-atom.ts#L33)
+Defined in: [play-atom/src/create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-atom.ts#L34)
+Defined in: [play-atom/src/create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/create-atom.ts#L34)
 The two forms of `createAtom`
@@ -59,7 +59,7 @@ because `get` tracked the edge already.
 CreateAtom<T>(initialValue, options?): Atom<T>;
 ```
-Defined in: [play-atom/src/create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-atom.ts#L35)
+Defined in: [play-atom/src/create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/create-atom.ts#L35)
 The two forms of `createAtom`

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

@@ -2,7 +2,7 @@
 # Interface: Readable\<T\>
-Defined in: [play-atom/src/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L58)
+Defined in: [play-atom/src/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L58)
 The read side of an atom
@@ -40,7 +40,7 @@ show(createAtom("ready")); // "ready"
 get(): T;
 ```
-Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L59)
+Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -56,7 +56,7 @@ Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L60)
+Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -78,7 +78,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L61)
+Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/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: [play-atom/src/types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L97)
+Defined in: [play-atom/src/types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L97)
 The computed atom. It evaluates late, and it memoizes the result
@@ -43,7 +43,7 @@ console.log(doubled.get()); // 10 (from the memory, with no new computation)
 get(): T;
 ```
-Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L59)
+Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L59)
 #### Returns
@@ -63,7 +63,7 @@ Defined in: [play-atom/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-
 subscribe(observer): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L60)
+Defined in: [play-atom/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L60)
 ##### Parameters
@@ -89,7 +89,7 @@ subscribe(
 ): AtomSubscription;
 ```
-Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L61)
+Defined in: [play-atom/src/types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L61)
 ##### Parameters

package/api/@xmachines/play-atom/type-aliases/AnyAtom.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type AnyAtom = BaseAtom<unknown>;
 ```
-Defined in: [play-atom/src/types.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L129)
+Defined in: [play-atom/src/types.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L129)
 An atom of an unknown value type

package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md CHANGED Viewed

@@ -17,7 +17,7 @@ type AsyncAtomState<TData, TError> =
 	  };
 ```
-Defined in: [play-atom/src/types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/types.ts#L157)
+Defined in: [play-atom/src/types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/types.ts#L157)
 The state of an atom that reads a promise

package/api/@xmachines/play-atom/type-aliases/Cleanup.md CHANGED Viewed

@@ -6,7 +6,7 @@
 type Cleanup = () => void & { [Key in DisposeKey]: () => void };
 ```
-Defined in: [play/src/disposable.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L66)
+Defined in: [play/src/disposable.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/disposable.ts#L66)
 The release of a subscription. A caller runs it, or a scope releases it.

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

@@ -7,7 +7,7 @@ const createAsyncAtom: <T>(getValue, options?) => ReadonlyAtom<AsyncAtomState<T>
 	createEngineAsyncAtom;
 ```
-Defined in: [play-atom/src/create-atom.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-atom.ts#L64)
+Defined in: [play-atom/src/create-atom.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/create-atom.ts#L64)
 Builds a read-only atom that holds the state of a promise

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

@@ -6,7 +6,7 @@
 const createAtom: CreateAtom = createEngineAtom;
 ```
-Defined in: [play-atom/src/create-atom.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-atom.ts#L47)
+Defined in: [play-atom/src/create-atom.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/create-atom.ts#L47)
 Builds a writable atom from a value, and a computed atom from a function

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

@@ -6,7 +6,7 @@
 const createWritableAtom: <T>(initialValue, options?) => Atom<T> = createAtom;
 ```
-Defined in: [play-atom/src/create-writable-atom.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-atom/src/create-writable-atom.ts#L50)
+Defined in: [play-atom/src/create-writable-atom.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-atom/src/create-writable-atom.ts#L50)
 Builds a WRITABLE atom, and never a computed one.