@xmachines/docs 3.0.0 → 5.0.0

package/api/@xmachines/play-signals/interfaces/SignalOptions.md

@@ -1,37 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalOptions
-
-# Interface: SignalOptions\<T\>
-
-Defined in: [packages/play-signals/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L27)
-
-The options of a Signal.State
-
-## Param
-
-**equals**
-
-The optional equality function of your own. It decides if the value changed
-
-## Example
-
-```typescript
-import { Signal } from "@xmachines/play-signals";
-import type { SignalOptions } from "@xmachines/play-signals";
-
-const options: SignalOptions<number> = {
-	equals: (a, b) => a === b,
-};
-const count = new Signal.State(0, options);
-```
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Properties
-
-| Property                               | Type                    | Description                                                        | Defined in                                                                                                                               |
-| -------------------------------------- | ----------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | The equality function of your own. It decides if the value changed | [packages/play-signals/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L34) |

package/api/@xmachines/play-signals/interfaces/SignalState.md

@@ -1,68 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalState
-
-# Interface: SignalState\<T\>
-
-Defined in: [packages/play-signals/src/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L54)
-
-The writable state signal. It holds one reactive value
-
-Signal.State is the base primitive of a reactive state. A `get()` call inside a
-computed signal or inside a watcher tracks the state as a dependency. A `set()`
-call notifies every computation and every watcher that depends on the state.
-
-## Example
-
-```typescript
-import { Signal } from "@xmachines/play-signals";
-
-const name = new Signal.State("Alice");
-console.log(name.get()); // 'Alice'
-name.set("Bob");
-console.log(name.get()); // 'Bob'
-```
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Methods
-
-### get()
-
-```ts
-get(): T;
-```
-
-Defined in: [packages/play-signals/src/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L60)
-
-Reads the current value, and tracks the signal as a dependency
-
-#### Returns
-
-`T`
-
-The current value of the signal
-
----
-
-### set()
-
-```ts
-set(value): void;
-```
-
-Defined in: [packages/play-signals/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L67)
-
-Writes a new value, and notifies the watchers when the value changed
-
-#### Parameters
-
-| Parameter | Type | Description   |
-| --------- | ---- | ------------- |
-| `value`   | `T`  | The new value |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-signals/interfaces/SignalWatcher.md

@@ -1,97 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalWatcher
-
-# Interface: SignalWatcher
-
-Defined in: [packages/play-signals/src/types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L169)
-
-The watcher. It observes each signal change and schedules an effect
-
-Signal.subtle.Watcher observes more than one signal, and it groups the updates.
-It is the low-level primitive, and a framework uses it to make a reactive effect.
-
-## Example
-
-```typescript
-import { Signal } from "@xmachines/play-signals";
-
-const count = new Signal.State(0);
-const doubled = new Signal.Computed(() => count.get() * 2);
-
-const watcher = new Signal.subtle.Watcher(() => {
-	queueMicrotask(() => {
-		const pending = watcher.getPending();
-		console.log("Signals changed:", pending.length);
-	});
-});
-
-watcher.watch(count);
-watcher.watch(doubled);
-
-count.set(5); // The watcher schedules the notification in a microtask
-```
-
-## Methods
-
-### getPending()
-
-```ts
-getPending(): (
-  | SignalState<unknown>
-  | SignalComputed<unknown>)[];
-```
-
-Defined in: [packages/play-signals/src/types.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L189)
-
-Returns the signals that changed after the last check
-
-#### Returns
-
-(
-\| [`SignalState`](SignalState.md)\<`unknown`\>
-\| [`SignalComputed`](SignalComputed.md)\<`unknown`\>)[]
-
-The array of the signals with an update that waits
-
----
-
-### unwatch()
-
-```ts
-unwatch(signal): void;
-```
-
-Defined in: [packages/play-signals/src/types.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L182)
-
-Stops the watch of one signal
-
-#### Parameters
-
-| Parameter | Type                                                                                                  | Description         |
-| --------- | ----------------------------------------------------------------------------------------------------- | ------------------- |
-| `signal`  | \| [`SignalState`](SignalState.md)\<`unknown`\> \| [`SignalComputed`](SignalComputed.md)\<`unknown`\> | The signal to leave |
-
-#### Returns
-
-`void`
-
----
-
-### watch()
-
-```ts
-watch(signal): void;
-```
-
-Defined in: [packages/play-signals/src/types.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-signals/src/types.ts#L175)
-
-Starts the watch of one signal
-
-#### Parameters
-
-| Parameter | Type                                                                                                  | Description                                  |
-| --------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------- |
-| `signal`  | \| [`SignalState`](SignalState.md)\<`unknown`\> \| [`SignalComputed`](SignalComputed.md)\<`unknown`\> | The signal to observe: a State or a Computed |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-signals/namespaces/Signal/README.md

@@ -1,22 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-signals](../../README.md) / Signal
-
-# Signal
-
-## Namespaces
-
-- [subtle](namespaces/subtle/README.md)
-
-## Classes
-
-- [Computed](classes/Computed.md)
-- [State](classes/State.md)
-
-## Interfaces
-
-- [Options](interfaces/Options.md)
-
-## Variables
-
-- [isComputed](variables/isComputed.md)
-- [isState](variables/isState.md)
-- [isWatcher](variables/isWatcher.md)

package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md

@@ -1,52 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / Computed
-
-# Class: Computed\<T\>
-
-Defined in: `signal-polyfill`
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Constructors
-
-### Constructor
-
-```ts
-new Computed<T>(computation, options?): Computed<T>;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter     | Type                                         |
-| ------------- | -------------------------------------------- |
-| `computation` | () => `T`                                    |
-| `options?`    | [`Options`](../interfaces/Options.md)\<`T`\> |
-
-#### Returns
-
-`Computed`\<`T`\>
-
-## Properties
-
-| Property                            | Modifier   | Type                  | Defined in |
-| ----------------------------------- | ---------- | --------------------- | ---------- |
-| <a id="property-node"></a> `[NODE]` | `readonly` | `ComputedNode`\<`T`\> | -          |
-
-## Methods
-
-### get()
-
-```ts
-get(): T;
-```
-
-Defined in: `signal-polyfill`
-
-#### Returns
-
-`T`

package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md

@@ -1,72 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / State
-
-# Class: State\<T\>
-
-Defined in: `signal-polyfill`
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Constructors
-
-### Constructor
-
-```ts
-new State<T>(initialValue, options?): State<T>;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter      | Type                                         |
-| -------------- | -------------------------------------------- |
-| `initialValue` | `T`                                          |
-| `options?`     | [`Options`](../interfaces/Options.md)\<`T`\> |
-
-#### Returns
-
-`State`\<`T`\>
-
-## Properties
-
-| Property                            | Modifier   | Type                | Defined in |
-| ----------------------------------- | ---------- | ------------------- | ---------- |
-| <a id="property-node"></a> `[NODE]` | `readonly` | `SignalNode`\<`T`\> | -          |
-
-## Methods
-
-### get()
-
-```ts
-get(): T;
-```
-
-Defined in: `signal-polyfill`
-
-#### Returns
-
-`T`
-
----
-
-### set()
-
-```ts
-set(newValue): void;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter  | Type |
-| ---------- | ---- |
-| `newValue` | `T`  |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md

@@ -1,19 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / Options
-
-# Interface: Options\<T\>
-
-Defined in: `signal-polyfill`
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Properties
-
-| Property                                       | Type                             | Defined in |
-| ---------------------------------------------- | -------------------------------- | ---------- |
-| <a id="property-unwatched"></a> `[unwatched]?` | (`this`) => `void`               | -          |
-| <a id="property-watched"></a> `[watched]?`     | (`this`) => `void`               | -          |
-| <a id="property-equals"></a> `equals?`         | (`this`, `t`, `t2`) => `boolean` | -          |

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md

@@ -1,21 +0,0 @@
-[API](../../../../../../README.md) / [@xmachines/play-signals](../../../../README.md) / [Signal](../../README.md) / subtle
-
-# subtle
-
-## Classes
-
-- [Watcher](classes/Watcher.md)
-
-## Variables
-
-- [unwatched](variables/unwatched.md)
-- [watched](variables/watched.md)
-
-## Functions
-
-- [currentComputed](functions/currentComputed.md)
-- [hasSinks](functions/hasSinks.md)
-- [hasSources](functions/hasSources.md)
-- [introspectSinks](functions/introspectSinks.md)
-- [introspectSources](functions/introspectSources.md)
-- [untrack](functions/untrack.md)

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md

@@ -1,85 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / Watcher
-
-# Class: Watcher
-
-Defined in: `signal-polyfill`
-
-## Constructors
-
-### Constructor
-
-```ts
-new Watcher(notify): Watcher;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter | Type               |
-| --------- | ------------------ |
-| `notify`  | (`this`) => `void` |
-
-#### Returns
-
-`Watcher`
-
-## Properties
-
-| Property                            | Modifier   | Type           | Defined in |
-| ----------------------------------- | ---------- | -------------- | ---------- |
-| <a id="property-node"></a> `[NODE]` | `readonly` | `ReactiveNode` | -          |
-
-## Methods
-
-### getPending()
-
-```ts
-getPending(): Computed<any>[];
-```
-
-Defined in: `signal-polyfill`
-
-#### Returns
-
-[`Computed`](../../../classes/Computed.md)\<`any`\>[]
-
----
-
-### unwatch()
-
-```ts
-unwatch(...signals): void;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter    | Type                   |
-| ------------ | ---------------------- |
-| ...`signals` | `AnySignal`\<`any`\>[] |
-
-#### Returns
-
-`void`
-
----
-
-### watch()
-
-```ts
-watch(...signals): void;
-```
-
-Defined in: `signal-polyfill`
-
-#### Parameters
-
-| Parameter    | Type                   |
-| ------------ | ---------------------- |
-| ...`signals` | `AnySignal`\<`any`\>[] |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md

@@ -1,13 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / currentComputed
-
-# Function: currentComputed()
-
-```ts
-function currentComputed(): Computed<any> | undefined;
-```
-
-Defined in: `signal-polyfill`
-
-## Returns
-
-[`Computed`](../../../classes/Computed.md)\<`any`\> \| `undefined`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md

@@ -1,19 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / hasSinks
-
-# Function: hasSinks()
-
-```ts
-function hasSinks(signal): boolean;
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type        |
-| --------- | ----------- |
-| `signal`  | `AnySignal` |
-
-## Returns
-
-`boolean`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md

@@ -1,19 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / hasSources
-
-# Function: hasSources()
-
-```ts
-function hasSources(signal): boolean;
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `signal`  | `AnySink` |
-
-## Returns
-
-`boolean`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md

@@ -1,19 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / introspectSinks
-
-# Function: introspectSinks()
-
-```ts
-function introspectSinks(signal): AnySink[];
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type        |
-| --------- | ----------- |
-| `signal`  | `AnySignal` |
-
-## Returns
-
-`AnySink`[]

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md

@@ -1,19 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / introspectSources
-
-# Function: introspectSources()
-
-```ts
-function introspectSources(sink): AnySignal<any>[];
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `sink`    | `AnySink` |
-
-## Returns
-
-`AnySignal`\<`any`\>[]

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md

@@ -1,25 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / untrack
-
-# Function: untrack()
-
-```ts
-function untrack<T>(cb): T;
-```
-
-Defined in: `signal-polyfill`
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `T`            |
-
-## Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `cb`      | () => `T` |
-
-## Returns
-
-`T`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md

@@ -1,9 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / unwatched
-
-# Variable: unwatched
-
-```ts
-const unwatched: unique symbol;
-```
-
-Defined in: `signal-polyfill`

package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md

@@ -1,9 +0,0 @@
-[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / watched
-
-# Variable: watched
-
-```ts
-const watched: unique symbol;
-```
-
-Defined in: `signal-polyfill`

package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md

@@ -1,19 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / isComputed
-
-# Variable: isComputed
-
-```ts
-isComputed: (s) => boolean;
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type  |
-| --------- | ----- |
-| `s`       | `any` |
-
-## Returns
-
-`boolean`

package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md

@@ -1,19 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / isState
-
-# Variable: isState
-
-```ts
-isState: (s) => boolean;
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type  |
-| --------- | ----- |
-| `s`       | `any` |
-
-## Returns
-
-`boolean`

package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md

@@ -1,19 +0,0 @@
-[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / isWatcher
-
-# Variable: isWatcher
-
-```ts
-isWatcher: (s) => boolean;
-```
-
-Defined in: `signal-polyfill`
-
-## Parameters
-
-| Parameter | Type  |
-| --------- | ----- |
-| `s`       | `any` |
-
-## Returns
-
-`boolean`