@ersbeth/picoflow 1.1.1 → 2.0.0

package/docs/api/interfaces/FlowConstant.md

@@ -0,0 +1,220 @@
+[@ersbeth/picoflow](/api/index.md) / FlowConstant
+
+# Interface: FlowConstant\<T\>
+
+Defined in: [api/nodes/sync/flowConstant.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowConstant.ts#L17)
+
+Read-only reactive value that computes once on initialization and never changes.
+
+Constants provide lazy initialization - the value isn't computed until first accessed via `get()` or `pick()`.
+Once computed, the value is cached forever. Use constants for expensive computations that only need to run once,
+such as loading configuration, computing static lookups, or initializing resources.
+
+## Extends
+
+- [`FlowValue`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.md#pick)
+
+***
+
+### 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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)

package/docs/api/interfaces/FlowConstantAsync.md

@@ -0,0 +1,221 @@
+[@ersbeth/picoflow](/api/index.md) / FlowConstantAsync
+
+# Interface: FlowConstantAsync\<T\>
+
+Defined in: [api/nodes/async/flowConstantAsync.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowConstantAsync.ts#L17)
+
+Read-only reactive value that resolves once from a promise or async initializer.
+
+Async constants provide lazy initialization for asynchronous values. The promise or async initializer
+runs once on first access, and the resolved value is cached forever. While pending, accessing the value
+throws PendingError. Use for async operations that only need to run once, such as loading remote configuration,
+fetching initial data, or computing expensive async resources.
+
+## Extends
+
+- [`FlowValue`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.md#pick)
+
+***
+
+### 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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)

package/docs/api/interfaces/FlowDerivation.md

@@ -0,0 +1,241 @@
+[@ersbeth/picoflow](/api/index.md) / FlowDerivation
+
+# Interface: FlowDerivation\<T\>
+
+Defined in: [api/nodes/sync/flowDerivation.ts:19](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowDerivation.ts#L19)
+
+Read-only reactive value that recomputes automatically when dependencies change.
+
+Derivations track reactive values accessed during computation and automatically recompute when any
+tracked dependency changes. The computed value is cached until dependencies change, avoiding unnecessary
+recomputations. Use derivations for values derived from other reactive state, such as filtered lists,
+computed properties, or aggregated data.
+
+## Extends
+
+- [`FlowValue`](/api/interfaces/FlowValue.md)\<`T`\>
+
+## Extended by
+
+- [`FlowWritableDerivation`](/api/interfaces/FlowWritableDerivation.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.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`
+
+***
+
+### 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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.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
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)