@xmachines/docs 5.0.1 → 6.0.0

package/api/@xmachines/play-dom-router/type-aliases/Cleanup.md

@@ -1,38 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / Cleanup
-
-# Type Alias: Cleanup
-
-```ts
-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)
-
-The release of a subscription. A caller runs it, or a scope releases it.
-
-The type is a function AND a `Disposable`, so one value serves both forms. A caller
-that holds the release in a field and runs it from a teardown keeps that code. A
-caller inside one scope writes `using` and writes no teardown at all:
-
-```ts
-// The explicit form. It stays correct.
-const stop = watchAtom(count, render);
-stop();
-
-// The scoped form. The scope releases it, and an exception releases it too.
-{
-	using stop = watchAtom(count, render);
-	render(count.get());
-}
-```
-
-`using` needs Node 24 or a browser with Explicit Resource Management, and it needs
-`"lib": ["ESNext"]` of the consumer. The publishable packages build at
-`target: "esnext"` and pass the syntax through, so the bundler of the consumer decides
-how to emit it. The `Cleanup` VALUE needs neither: a runtime without `Symbol.dispose`
-still calls it as a function, and a consumer that declares a lower `lib` still reads
-the type. See [DisposeKey](../../play/index/type-aliases/DisposeKey.md) for the second half of that.
-
-## See
-
-[Play RFC](../../../../rfc/play.md)

package/api/@xmachines/play-dom-router/variables/DISPOSE.md

@@ -1,34 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / DISPOSE
-
-# Variable: DISPOSE
-
-```ts
-const DISPOSE: DisposeKey;
-```
-
-Defined in: [play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/disposable.ts#L94)
-
-The key that a release is stored under.
-
-`Symbol.dispose` where the runtime has it, and `Symbol.for("Symbol.dispose")` where it
-does not. This is not a convenience — it is the difference between a `using` that
-releases and one that raises.
-
-A bundler that downlevels `using` for a target below Chrome 134 emits a helper that
-reads `object[Symbol.dispose || Symbol.for("Symbol.dispose")]`. A release stored under
-a bare `[Symbol.dispose]` lands on the string key `"undefined"` in that runtime,
-because the well-known symbol is absent and the computed key takes the value
-`undefined`. The helper then looks up the registered symbol, finds nothing, and throws
-`TypeError: Object is not disposable`. Storing under the same fallback closes the gap.
-
-The type assertion states what the fallback IS. `Symbol.for` returns a plain `symbol`,
-TypeScript declares `Symbol.dispose` as a `unique symbol`, and no expression produces
-a `unique symbol` other than the declaration itself.
-
-This binding resolves ONE time, when the module evaluates. [asCleanup](../functions/asCleanup.md) therefore
-reads `Symbol.dispose` again at each call and stores the release under both keys, so a
-polyfill that installs the well-known symbol after this module evaluates still finds
-the release. A class or an object literal that writes `[DISPOSE]()` has no such second
-chance: it carries the key that existed when it was defined. Install an Explicit
-Resource Management polyfill before the first import of `@xmachines/play`, which is the
-ordinary contract of a polyfill.

package/api/@xmachines/play-pattern/interfaces/PatternCache.md

@@ -1,65 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-pattern](../README.md) / PatternCache
-
-# Interface: PatternCache\<V\>
-
-Defined in: [cache.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L53)
-
-What this package needs from a cache: a read and a write, both by a string key.
-
-The contract is this small on purpose. A `Map` satisfies it, and so does an LRU of any
-library — a caller that wants a time to live or an eviction callback brings the module
-that has one, and this package needs to know nothing about it.
-
-A cache may forget an entry at any time, and it may forget none. Both are correct: the
-parser runs again for an entry that is absent.
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `V`            |
-
-## Methods
-
-### get()
-
-```ts
-get(key): V | undefined;
-```
-
-Defined in: [cache.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L55)
-
-Reads one entry, or `undefined` when the cache holds none for the key.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-
-#### Returns
-
-`V` \| `undefined`
-
----
-
-### set()
-
-```ts
-set(key, value): void;
-```
-
-Defined in: [cache.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L57)
-
-Writes one entry.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-| `value`   | `V`      |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-router/index/interfaces/PatternCache.md

@@ -1,65 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / PatternCache
-
-# Interface: PatternCache\<V\>
-
-Defined in: [packages/play-pattern/src/cache.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L53)
-
-What this package needs from a cache: a read and a write, both by a string key.
-
-The contract is this small on purpose. A `Map` satisfies it, and so does an LRU of any
-library — a caller that wants a time to live or an eviction callback brings the module
-that has one, and this package needs to know nothing about it.
-
-A cache may forget an entry at any time, and it may forget none. Both are correct: the
-parser runs again for an entry that is absent.
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `V`            |
-
-## Methods
-
-### get()
-
-```ts
-get(key): V | undefined;
-```
-
-Defined in: [packages/play-pattern/src/cache.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L55)
-
-Reads one entry, or `undefined` when the cache holds none for the key.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-
-#### Returns
-
-`V` \| `undefined`
-
----
-
-### set()
-
-```ts
-set(key, value): void;
-```
-
-Defined in: [packages/play-pattern/src/cache.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L57)
-
-Writes one entry.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-| `value`   | `V`      |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-url/index/interfaces/PatternCache.md

@@ -1,65 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-url](../../README.md) / [index](../README.md) / PatternCache
-
-# Interface: PatternCache\<V\>
-
-Defined in: [packages/play-pattern/src/cache.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L53)
-
-What this package needs from a cache: a read and a write, both by a string key.
-
-The contract is this small on purpose. A `Map` satisfies it, and so does an LRU of any
-library — a caller that wants a time to live or an eviction callback brings the module
-that has one, and this package needs to know nothing about it.
-
-A cache may forget an entry at any time, and it may forget none. Both are correct: the
-parser runs again for an entry that is absent.
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `V`            |
-
-## Methods
-
-### get()
-
-```ts
-get(key): V | undefined;
-```
-
-Defined in: [packages/play-pattern/src/cache.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L55)
-
-Reads one entry, or `undefined` when the cache holds none for the key.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-
-#### Returns
-
-`V` \| `undefined`
-
----
-
-### set()
-
-```ts
-set(key, value): void;
-```
-
-Defined in: [packages/play-pattern/src/cache.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L57)
-
-Writes one entry.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `key`     | `string` |
-| `value`   | `V`      |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-xstate/index/variables/DISPOSE.md

@@ -1,34 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-xstate](../../README.md) / [index](../README.md) / DISPOSE
-
-# Variable: DISPOSE
-
-```ts
-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)
-
-The key that a release is stored under.
-
-`Symbol.dispose` where the runtime has it, and `Symbol.for("Symbol.dispose")` where it
-does not. This is not a convenience — it is the difference between a `using` that
-releases and one that raises.
-
-A bundler that downlevels `using` for a target below Chrome 134 emits a helper that
-reads `object[Symbol.dispose || Symbol.for("Symbol.dispose")]`. A release stored under
-a bare `[Symbol.dispose]` lands on the string key `"undefined"` in that runtime,
-because the well-known symbol is absent and the computed key takes the value
-`undefined`. The helper then looks up the registered symbol, finds nothing, and throws
-`TypeError: Object is not disposable`. Storing under the same fallback closes the gap.
-
-The type assertion states what the fallback IS. `Symbol.for` returns a plain `symbol`,
-TypeScript declares `Symbol.dispose` as a `unique symbol`, and no expression produces
-a `unique symbol` other than the declaration itself.
-
-This binding resolves ONE time, when the module evaluates. [asCleanup](../../../play/index/functions/asCleanup.md) therefore
-reads `Symbol.dispose` again at each call and stores the release under both keys, so a
-polyfill that installs the well-known symbol after this module evaluates still finds
-the release. A class or an object literal that writes `[DISPOSE]()` has no such second
-chance: it carries the key that existed when it was defined. Install an Explicit
-Resource Management polyfill before the first import of `@xmachines/play`, which is the
-ordinary contract of a polyfill.

package/examples/@xmachines/play-react-demo/functions/App.md

@@ -1,13 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / App
-
-# Function: App()
-
-```ts
-function App(): Element;
-```
-
-Defined in: [packages/play-react/examples/demo/src/App.tsx:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/App.tsx#L68)
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-react-demo/functions/DebugPanel.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / DebugPanel
-
-# Function: DebugPanel()
-
-```ts
-function DebugPanel(__namedParameters): Element;
-```
-
-Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
-
-## Parameters
-
-| Parameter                 | Type                        |
-| ------------------------- | --------------------------- |
-| `__namedParameters`       | \{ `actor`: `AuthActor`; \} |
-| `__namedParameters.actor` | `AuthActor`                 |
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-react-demo/functions/HeaderNav.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / HeaderNav
-
-# Function: HeaderNav()
-
-```ts
-function HeaderNav(__namedParameters): Element;
-```
-
-Defined in: [components/HeaderNav.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
-
-## Parameters
-
-| Parameter                 | Type                        |
-| ------------------------- | --------------------------- |
-| `__namedParameters`       | \{ `actor`: `AuthActor`; \} |
-| `__namedParameters.actor` | `AuthActor`                 |
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-react-demo/functions/Shell.md

@@ -1,22 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Shell
-
-# Function: Shell()
-
-```ts
-function Shell(__namedParameters): Element;
-```
-
-Defined in: [components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
-
-## Parameters
-
-| Parameter                    | Type                                                                               | Description                                                                      |
-| ---------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `__namedParameters`          | \{ `actor`: `AuthActor`; `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | -                                                                                |
-| `__namedParameters.actor`    | `AuthActor`                                                                        | -                                                                                |
-| `__namedParameters.registry` | `ComponentRegistry`                                                                | -                                                                                |
-| `__namedParameters.router?`  | `unknown`                                                                          | Bridged router instance — accepted for prop parity with router demos but unused. |
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-solid-demo/functions/App.md

@@ -1,13 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / App
-
-# Function: App()
-
-```ts
-function App(): Element;
-```
-
-Defined in: [packages/play-solid/examples/demo/src/App.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-solid/examples/demo/src/App.tsx#L34)
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / DebugPanel
-
-# Function: DebugPanel()
-
-```ts
-function DebugPanel(props): Element;
-```
-
-Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
-
-## Parameters
-
-| Parameter     | Type                        |
-| ------------- | --------------------------- |
-| `props`       | \{ `actor`: `AuthActor`; \} |
-| `props.actor` | `AuthActor`                 |
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / HeaderNav
-
-# Function: HeaderNav()
-
-```ts
-function HeaderNav(props): Element;
-```
-
-Defined in: [components/HeaderNav.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/HeaderNav.tsx#L5)
-
-## Parameters
-
-| Parameter     | Type                        |
-| ------------- | --------------------------- |
-| `props`       | \{ `actor`: `AuthActor`; \} |
-| `props.actor` | `AuthActor`                 |
-
-## Returns
-
-`Element`

package/examples/@xmachines/play-solid-demo/functions/Shell.md

@@ -1,22 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / Shell
-
-# Function: Shell()
-
-```ts
-function Shell(props): Element;
-```
-
-Defined in: [components/Shell.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/Shell.tsx#L7)
-
-## Parameters
-
-| Parameter        | Type                                                                               | Description                                                                      |
-| ---------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `props`          | \{ `actor`: `AuthActor`; `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | -                                                                                |
-| `props.actor`    | `AuthActor`                                                                        | -                                                                                |
-| `props.registry` | `ComponentRegistry`                                                                | -                                                                                |
-| `props.router?`  | `unknown`                                                                          | Bridged router instance — accepted for prop parity with router demos but unused. |
-
-## Returns
-
-`Element`