@ersbeth/picoflow 2.0.2 → 2.1.0

package/docs/api/interfaces/FlowValue.md

@@ -1,222 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowValue
-
-# Interface: FlowValue\<T\>
-
-Defined in: [api/nodes/flowValue.ts:13](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L13)
-
-Base interface for reactive values that can be read synchronously or asynchronously.
-
-FlowValue extends FlowObservable with methods to access the current value. Use `get()` to read
-the value reactively (establishing a dependency), or `pick()` to read it non-reactively. All
-value-based primitives (state, derivation, constant, and their async variants) implement this
-interface, providing a consistent API for value access across the reactive system.
-
-## Extends
-
-- [`FlowObservable`](/api/interfaces/FlowObservable.md)\<`T`\>
-
-## Extended by
-
-- [`FlowConstantAsync`](/api/interfaces/FlowConstantAsync.md)
-- [`FlowDerivationAsync`](/api/interfaces/FlowDerivationAsync.md)
-- [`FlowStateAsync`](/api/interfaces/FlowStateAsync.md)
-- [`FlowConstant`](/api/interfaces/FlowConstant.md)
-- [`FlowDerivation`](/api/interfaces/FlowDerivation.md)
-- [`FlowState`](/api/interfaces/FlowState.md)
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Accessors
-
-### disposed
-
-#### Get Signature
-
-```ts
-get disposed(): boolean;
-```
-
-Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
-
-Indicates whether this resource has been disposed.
-
-Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
-the resource is no longer usable and any operations on it will throw errors.
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[`FlowObservable`](/api/interfaces/FlowObservable.md).[`disposed`](/api/interfaces/FlowObservable.md#disposed)
-
-## Methods
-
-### dispose()
-
-```ts
-dispose(): void;
-```
-
-Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
-
-Releases all resources held by this disposable object.
-
-Cleans up all subscriptions, dependencies, and internal state. After calling this method,
-the resource enters a disposed state and cannot be reused. Any subsequent operations will
-throw errors. This method should be called when you no longer need the reactive primitive
-to prevent memory leaks.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowObservable`](/api/interfaces/FlowObservable.md).[`dispose`](/api/interfaces/FlowObservable.md#dispose)
-
-***
-
-### get()
-
-```ts
-get(tracker): T;
-```
-
-Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
-
-Gets the current value and establishes a reactive dependency.
-
-When called from within a reactive computation, this method registers the value as a dependency,
-ensuring the computation re-executes when the value changes. The value is computed on first access
-(if lazy) and then cached. For async values, throws PendingError while the value is resolving.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
-
-#### Returns
-
-`T`
-
-The current value
-
-***
-
-### pick()
-
-```ts
-pick(): Promise<T>;
-```
-
-Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
-
-Asynchronously gets the current value without establishing a reactive dependency.
-
-This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
-computation when the value changes. The value is computed on first access (if lazy) and then cached.
-For async values, the promise resolves once the value is available.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-Promise that resolves with the current value
-
-***
-
-### subscribe()
-
-```ts
-subscribe(
-   onData, 
-   onError?, 
-   onPending?): FlowEffect;
-```
-
-Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
-
-Subscribes to this observable with lifecycle callbacks.
-
-Creates an active subscription that executes immediately and then re-executes whenever
-the observable's dependencies change. The subscription remains active until the returned
-disposal function is called. The `onData` callback receives the computed value, while
-`onError` handles errors and `onPending` signals async operations in progress.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
-| `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
-| `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
-
-#### Returns
-
-[`FlowEffect`](/api/interfaces/FlowEffect.md)
-
-A function to dispose the subscription and stop receiving updates
-
-#### Inherited from
-
-[`FlowObservable`](/api/interfaces/FlowObservable.md).[`subscribe`](/api/interfaces/FlowObservable.md#subscribe)
-
-***
-
-### trigger()
-
-```ts
-trigger(): void;
-```
-
-Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
-
-Manually triggers notifications to all dependents.
-
-Forces all dependents of this observable to be notified and re-executed, even if the
-value hasn't actually changed. Useful for imperatively triggering updates when the
-reactive system cannot detect changes automatically.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowObservable`](/api/interfaces/FlowObservable.md).[`trigger`](/api/interfaces/FlowObservable.md#trigger)
-
-***
-
-### watch()
-
-```ts
-watch(tracker): void;
-```
-
-Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
-
-Establishes a reactive dependency without reading the value.
-
-Registers this observable as a dependency of the given tracker, allowing it to be notified
-when changes occur. This enables dependency tracking without accessing the actual value.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowObservable`](/api/interfaces/FlowObservable.md).[`watch`](/api/interfaces/FlowObservable.md#watch)

package/docs/api/interfaces/FlowWritableDerivation.md

@@ -1,292 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowWritableDerivation
-
-# Interface: FlowWritableDerivation\<T\>
-
-Defined in: [api/nodes/sync/flowWritableDerivation.ts:15](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowWritableDerivation.ts#L15)
-
-Writable reactive value that recomputes automatically when dependencies change, but can be manually overridden.
-
-Writable derivations combine reactive computation with manual control. They track dependencies and recompute
-like regular derivations, but you can also call `set()` to override the computed value temporarily. Use this
-for computed values that users can edit, such as formatted fields, calculated totals that can be adjusted,
-or any value that is usually derived but sometimes needs manual correction.
-
-## Extends
-
-- [`FlowState`](/api/interfaces/FlowState.md)\<`T`\>.[`FlowDerivation`](/api/interfaces/FlowDerivation.md)\<`T`\>
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Accessors
-
-### disposed
-
-#### Get Signature
-
-```ts
-get disposed(): boolean;
-```
-
-Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
-
-Indicates whether this resource has been disposed.
-
-Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
-the resource is no longer usable and any operations on it will throw errors.
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`disposed`](/api/interfaces/FlowState.md#disposed)
-
-## Methods
-
-### dispose()
-
-```ts
-dispose(): void;
-```
-
-Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
-
-Releases all resources held by this disposable object.
-
-Cleans up all subscriptions, dependencies, and internal state. After calling this method,
-the resource enters a disposed state and cannot be reused. Any subsequent operations will
-throw errors. This method should be called when you no longer need the reactive primitive
-to prevent memory leaks.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`dispose`](/api/interfaces/FlowState.md#dispose)
-
-***
-
-### get()
-
-```ts
-get(tracker): T;
-```
-
-Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
-
-Gets the current value and establishes a reactive dependency.
-
-When called from within a reactive computation, this method registers the value as a dependency,
-ensuring the computation re-executes when the value changes. The value is computed on first access
-(if lazy) and then cached. For async values, throws PendingError while the value is resolving.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
-
-#### Returns
-
-`T`
-
-The current value
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`get`](/api/interfaces/FlowState.md#get)
-
-***
-
-### pick()
-
-```ts
-pick(): Promise<T>;
-```
-
-Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
-
-Asynchronously gets the current value without establishing a reactive dependency.
-
-This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
-computation when the value changes. The value is computed on first access (if lazy) and then cached.
-For async values, the promise resolves once the value is available.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-Promise that resolves with the current value
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`pick`](/api/interfaces/FlowState.md#pick)
-
-***
-
-### refresh()
-
-```ts
-refresh(): void;
-```
-
-Defined in: [api/nodes/sync/flowDerivation.ts:23](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowDerivation.ts#L23)
-
-Forces the derivation to recompute even if dependencies haven't changed.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowDerivation`](/api/interfaces/FlowDerivation.md).[`refresh`](/api/interfaces/FlowDerivation.md#refresh)
-
-***
-
-### set()
-
-#### Call Signature
-
-```ts
-set(value): void;
-```
-
-Defined in: [api/nodes/sync/flowState.ts:25](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L25)
-
-Updates the state with a new value or via an updater function.
-Notifies all dependents after the update.
-
-##### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | [`NotPromise`](/api/type-aliases/NotPromise.md)\<`T`\> | New value to set, or function that receives current value and returns new value |
-
-##### Returns
-
-`void`
-
-##### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`set`](/api/interfaces/FlowState.md#set)
-
-#### Call Signature
-
-```ts
-set(updater): void;
-```
-
-Defined in: [api/nodes/sync/flowState.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L26)
-
-##### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `updater` | [`UpdateFunction`](/api/type-aliases/UpdateFunction.md)\<`T`\> |
-
-##### Returns
-
-`void`
-
-##### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`set`](/api/interfaces/FlowState.md#set)
-
-***
-
-### subscribe()
-
-```ts
-subscribe(
-   onData, 
-   onError?, 
-   onPending?): FlowEffect;
-```
-
-Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
-
-Subscribes to this observable with lifecycle callbacks.
-
-Creates an active subscription that executes immediately and then re-executes whenever
-the observable's dependencies change. The subscription remains active until the returned
-disposal function is called. The `onData` callback receives the computed value, while
-`onError` handles errors and `onPending` signals async operations in progress.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
-| `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
-| `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
-
-#### Returns
-
-[`FlowEffect`](/api/interfaces/FlowEffect.md)
-
-A function to dispose the subscription and stop receiving updates
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`subscribe`](/api/interfaces/FlowState.md#subscribe)
-
-***
-
-### trigger()
-
-```ts
-trigger(): void;
-```
-
-Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
-
-Manually triggers notifications to all dependents.
-
-Forces all dependents of this observable to be notified and re-executed, even if the
-value hasn't actually changed. Useful for imperatively triggering updates when the
-reactive system cannot detect changes automatically.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`trigger`](/api/interfaces/FlowState.md#trigger)
-
-***
-
-### watch()
-
-```ts
-watch(tracker): void;
-```
-
-Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
-
-Establishes a reactive dependency without reading the value.
-
-Registers this observable as a dependency of the given tracker, allowing it to be notified
-when changes occur. This enables dependency tracking without accessing the actual value.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowState`](/api/interfaces/FlowState.md).[`watch`](/api/interfaces/FlowState.md#watch)