@xmachines/docs 4.0.0 → 5.0.1

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`

package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md

@@ -1,33 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-signals](../README.md) / WatcherNotify
-
-# Type Alias: WatcherNotify
-
-```ts
-type WatcherNotify = () => void;
-```
-
-Defined in: [packages/play-signals/src/types.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-signals/src/types.ts#L141)
-
-The notification callback of a Signal.subtle.Watcher
-
-The watcher calls it after a signal that it watches changes. Use the microtask
-batching pattern to group rapid updates. The README of signal-polyfill gives the
-best practice.
-
-## Returns
-
-`void`
-
-## Example
-
-```typescript
-import { Signal } from "@xmachines/play-signals";
-
-const notify: WatcherNotify = () => {
-	queueMicrotask(() => {
-		const pending = watcher.getPending();
-		// Process the signal changes that wait
-	});
-};
-const watcher = new Signal.subtle.Watcher(notify);
-```

package/api/@xmachines/play-url/index/functions/getNormalizedParamNameMap.md

@@ -1,32 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / getNormalizedParamNameMap
-
-# Function: getNormalizedParamNameMap()
-
-```ts
-function getNormalizedParamNameMap(path): ReadonlyMap<string, string>;
-```
-
-Defined in: [packages/play-url/src/url-pattern-utils.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/url-pattern-utils.ts#L154)
-
-Builds the map from each normalized URLPattern group name back to the original param
-name, which holds a hyphen, of a route pattern.
-
-The map holds only the params that [normalizeParamNames](normalizeParamNames.md) rewrote. A param with a
-valid identifier keeps its own name, and it needs no entry.
-
-## Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-## Returns
-
-`ReadonlyMap`\<`string`, `string`\>
-
-## Example
-
-```ts
-getNormalizedParamNameMap("/docs/:cat-id/:plain");
-// → Map { "cat_id" → "cat-id" }
-```

package/api/@xmachines/play-url/index/functions/getPatternParamNames.md

@@ -1,29 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / getPatternParamNames
-
-# Function: getPatternParamNames()
-
-```ts
-function getPatternParamNames(pattern): string[];
-```
-
-Defined in: [packages/play-url/src/framework-params.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/framework-params.ts#L26)
-
-Reads the names of every `:param` of a route pattern of the route map.
-
-The names come from the parse of `pattern-grammar.ts`, which reads the WHOLE grammar:
-a `{…}` group and a `(\d+)` constraint both hide a name from an expression that looks
-for `:name` alone. An ANONYMOUS param — `*` and a bare `(\d+)` — carries no name, and
-the list therefore holds none.
-
-## Parameters
-
-| Parameter | Type     | Description                                      |
-| --------- | -------- | ------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId`. |
-
-## Returns
-
-`string`[]
-
-The names, in the order that the pattern declares them. A fresh array, because
-`parsePattern` caches the parse that it reads.

package/api/@xmachines/play-url/index/functions/getRequiredPatternParamNames.md

@@ -1,39 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / getRequiredPatternParamNames
-
-# Function: getRequiredPatternParamNames()
-
-```ts
-function getRequiredPatternParamNames(pattern): string[];
-```
-
-Defined in: [packages/play-url/src/framework-params.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/framework-params.ts#L52)
-
-The names of every param the pattern REQUIRES, so an optional one is left out.
-
-A param is optional when its own modifier is `?` or `*`, and when EVERY group above it
-carries one of the two. `?` alone was the test before, and it read `/files/:path*` and
-`/books{/:id}?` as required patterns: a path that fills neither then counted as a gap,
-the pick was discarded, and a correct parse from Vue Router or SolidJS Router went with
-it. That is the same class of defect as the all-optional bug of !133, for the modifiers
-that the fix did not cover.
-
-An optional segment that did not match has no value, and a framework reports none. That
-is a complete answer and not a partial one, so a MIXED pattern such as
-`/profile/:userId/:tab?` keeps the parse of the framework when only `:tab` is absent.
-
-A pattern whose params are ALL optional reports nothing at all, which reads the same as
-"the framework matched another route", so [pickOwnParams](pickOwnParams.md) falls back for it.
-[resolveFrameworkParams](resolveFrameworkParams.md) settles that case from the PATH instead.
-
-## Parameters
-
-| Parameter | Type     | Description                                            |
-| --------- | -------- | ------------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId/:tab?`. |
-
-## Returns
-
-`string`[]
-
-The required names, in the order that the pattern declares them. A fresh
-array, because `parsePattern` caches the parse that it reads.

package/api/@xmachines/play-url/index/functions/isParameterizedPattern.md

@@ -1,36 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / isParameterizedPattern
-
-# Function: isParameterizedPattern()
-
-```ts
-function isParameterizedPattern(pattern): boolean;
-```
-
-Defined in: [packages/play-url/src/url-pattern-utils.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/url-pattern-utils.ts#L97)
-
-Tells you if a route path needs a URLPattern match, and is not a concrete URL.
-
-A pattern holds a param — `:name`, `(\d+)` or `*` — or a `{…}` group, or an escape.
-Each of them needs a match, and each of them carries no concrete value, so the code
-can push such a path to a browser URL never.
-
-This function is THE single source of truth of the question "is this path a pattern?".
-`RouteMap` uses it for its decision between the static map and the index of the pattern
-buckets, and `extractRouteParams` uses it to answer `{}` for a literal path. A CONCRETE
-path asks [holdsUnsubstitutedParam](holdsUnsubstitutedParam.md) instead, and never this function.
-
-The answer comes from the parse, and not from a search for a `:` or a `*`. That search
-called `/a{/b}?/c` a static path, and `RouteMap` then put it in the exact-match map,
-where the path `/a/c` reached it never.
-
-## Parameters
-
-| Parameter | Type     | Description                                                                                 |
-| --------- | -------- | ------------------------------------------------------------------------------------------- |
-| `pattern` | `string` | The string of a URL path or of a route pattern, for example `/profile/:userId` or `/docs/*` |
-
-## Returns
-
-`boolean`
-
-`true` when the path needs a URLPattern match

package/api/@xmachines/play-url/index/functions/normalizeParamNames.md

@@ -1,36 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / normalizeParamNames
-
-# Function: normalizeParamNames()
-
-```ts
-function normalizeParamNames(path): string;
-```
-
-Defined in: [packages/play-url/src/url-pattern-utils.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/url-pattern-utils.ts#L139)
-
-Normalizes a route path, so that each of its parameter names is a valid URLPattern
-identifier.
-
-URLPattern requires a valid JS identifier as a parameter name, and such an identifier
-holds no hyphen. Therefore the function replaces a name with a hyphen, for example
-`:cat-id`, with the equivalent name with an underscore (`:cat_id`), for the compilation
-step of URLPattern. A caller that needs the values of the captured groups, and not a
-test of the match alone, must map each normalized group name back to the original param
-name with [getNormalizedParamNameMap](getNormalizedParamNameMap.md).
-
-## Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `path`    | `string` |
-
-## Returns
-
-`string`
-
-## Example
-
-```ts
-normalizeParamNames("/docs/:cat-id/:page-num?");
-// → "/docs/:cat_id/:page_num?"
-```