@ersbeth/picoflow 0.0.1 → 0.1.0

package/api/doc/index.md

@@ -19,7 +19,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[picoflow](./picoflow.md)
+[@ersbeth/picoflow](./picoflow.md)
 
 
 </td><td>

package/api/doc/picoflow.constant.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [constant](./picoflow.constant.md)
+
+## constant() function
+
+Creates a new reactive constant.
+
+**Signature:**
+
+```typescript
+export declare function constant<T>(value: T | (() => T)): FlowConstant<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T \| (() =&gt; T)
+
+
+</td><td>
+
+The value or a function that returns the value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowConstant](./picoflow.flowconstant.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowConstant](./picoflow.flowconstant.md)<!-- -->.
+

package/api/doc/picoflow.derivation.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [derivation](./picoflow.derivation.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [derivation](./picoflow.derivation.md)
 
 ## derivation() function
 

package/api/doc/picoflow.effect.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [effect](./picoflow.effect.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [effect](./picoflow.effect.md)
 
 ## effect() function
 

package/api/doc/picoflow.flowconstant._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md) &gt; [(constructor)](./picoflow.flowconstant._constructor_.md)
+
+## FlowConstant.(constructor)
+
+Creates a new FlowConstant instance.
+
+**Signature:**
+
+```typescript
+constructor(value: T | (() => T));
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T \| (() =&gt; T)
+
+
+</td><td>
+
+Either a direct value of type T or a function returning a value of type T for lazy initialization.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowconstant.get.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md) &gt; [get](./picoflow.flowconstant.get.md)
+
+## FlowConstant.get() method
+
+Retrieves the constant value, computing it lazily if needed.
+
+Accessing this method will initialize the value if it has not been computed already. Throws an error if the instance has been disposed or if lazy initialization fails.
+
+**Signature:**
+
+```typescript
+get(): T;
+```
+**Returns:**
+
+T
+
+The cached constant value.
+
+## Exceptions
+
+Error if the constant is disposed or cannot be initialized.
+

package/api/doc/picoflow.flowconstant.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md)
+
+## FlowConstant class
+
+Represents a reactive and immutable constant value computed lazily upon first access.
+
+**Signature:**
+
+```typescript
+export declare class FlowConstant<T> extends FlowObservable<T> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+
+## Remarks
+
+This class extends FlowObservable and supports initializing the constant using either a direct value or a lazy initializer function. Once computed, the value is cached for all subsequent accesses.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(value)](./picoflow.flowconstant._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowConstant instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[get()](./picoflow.flowconstant.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the constant value, computing it lazily if needed.
+
+Accessing this method will initialize the value if it has not been computed already. Throws an error if the instance has been disposed or if lazy initialization fails.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowderivation._constructor_.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [(constructor)](./picoflow.flowderivation._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [(constructor)](./picoflow.flowderivation._constructor_.md)
 
 ## FlowDerivation.(constructor)
 
@@ -42,7 +42,7 @@ compute
 
 </td><td>
 
-A function that computes the derived value. It is provided with a getter and a watcher function to access observables and signals dependencies.
+A function that computes the derived value. It is provided with two parameters: a getter and a watcher that respect dependency tracking.
 
 
 </td></tr>

package/api/doc/picoflow.flowderivation.get.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [get](./picoflow.flowderivation.get.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [get](./picoflow.flowderivation.get.md)
 
 ## FlowDerivation.get() method
 
@@ -19,5 +19,5 @@ The current computed value.
 
 ## Remarks
 
-This method ensures that the derivation is up-to-date before returning the value.
+This method lazily initializes and updates the derivation if it is marked as dirty. It throws an error if the derivation has been disposed.
 

package/api/doc/picoflow.flowderivation.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md)
 
 ## FlowDerivation class
 
@@ -15,7 +15,7 @@ export declare class FlowDerivation<T> extends FlowObservable<T>
 
 ## Remarks
 
-A FlowDerivation automatically tracks its dependencies and recomputes its value when needed.
+It tracks dependencies automatically and recomputes its value when any dependency changes. Use FlowDerivation to create derived values in a reactive manner. It lazily initializes the computed value, ensuring that computations only occur when necessary.
 
 ## Constructors
 

package/api/doc/picoflow.floweffect._constructor_.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [(constructor)](./picoflow.floweffect._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [(constructor)](./picoflow.floweffect._constructor_.md)
 
 ## FlowEffect.(constructor)
 
@@ -42,8 +42,13 @@ apply
 
 </td><td>
 
-A function that performs the side effect. It receives a getter and a watcher function to access and register dependencies on reactive observables and signals.
+A side-effect function that receives a getter and a watcher to access and register dependencies on reactive observables and signals.
 
 
 </td></tr>
 </tbody></table>
+
+## Remarks
+
+The provided function is executed immediately in a tracked mode to collect dependencies. On subsequent executions, it runs in an untracked mode.
+

package/api/doc/picoflow.floweffect.dispose.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [dispose](./picoflow.floweffect.dispose.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [dispose](./picoflow.floweffect.dispose.md)
 
 ## FlowEffect.dispose() method
 
-Disposes the effect, unregistering all its dependencies.
+Disposes the effect, unregistering all its tracked dependencies.
 
 **Signature:**
 
@@ -17,5 +17,5 @@ void
 
 ## Remarks
 
-After disposal, the effect should no longer be used. Calling this method on an already disposed effect will throw an error.
+Once disposed, the effect must no longer be used. Trying to dispose an effect that is already disposed will throw an error.
 

package/api/doc/picoflow.floweffect.disposed.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [disposed](./picoflow.floweffect.disposed.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [disposed](./picoflow.floweffect.disposed.md)
 
 ## FlowEffect.disposed property
 

package/api/doc/picoflow.floweffect.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md)
 
 ## FlowEffect class
 
-Represents a reactive effect that executes a side‐effect function based on its tracked dependencies.
+Represents a reactive effect that executes side-effect functions based on its tracked dependencies.
 
 **Signature:**
 
@@ -14,7 +14,7 @@ export declare class FlowEffect
 
 ## Remarks
 
-A FlowEffect runs an apply function to perform side effects. The apply function is executed in two modes: Initially, in a tracked mode to register dependencies. Subsequently, in an untracked mode to only re-execute the effect .
+The FlowEffect executes an apply function that performs side effects, running initially in a tracked mode to register dependencies and then in an untracked mode to re-execute the effect on updates.
 
 ## Constructors
 
@@ -124,7 +124,7 @@ Description
 
 </td><td>
 
-Disposes the effect, unregistering all its dependencies.
+Disposes the effect, unregistering all its tracked dependencies.
 
 
 </td></tr>

package/api/doc/picoflow.flowgetter.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowGetter](./picoflow.flowgetter.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowGetter](./picoflow.flowgetter.md)
 
 ## FlowGetter type
 
-A function for retrieving the current value from a FlowObservable.
+A function that retrieves the current value from a FlowObservable.
 
 **Signature:**
 

package/api/doc/picoflow.flowmap._lastdeleted.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastDeleted](./picoflow.flowmap._lastdeleted.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastDeleted](./picoflow.flowmap._lastdeleted.md)
 
 ## FlowMap.$lastDeleted property
 

package/api/doc/picoflow.flowmap._lastset.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastSet](./picoflow.flowmap._lastset.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastSet](./picoflow.flowmap._lastset.md)
 
 ## FlowMap.$lastSet property
 

package/api/doc/picoflow.flowmap.delete.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [delete](./picoflow.flowmap.delete.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [delete](./picoflow.flowmap.delete.md)
 
 ## FlowMap.delete() method
 
@@ -51,7 +51,11 @@ The key to delete.
 
 void
 
+## Exceptions
+
+If the FlowMap instance is disposed.
+
 ## Remarks
 
-This method removes the key from the internal map, emits the deleted key and its corresponding value via [FlowMap.$lastDeleted](./picoflow.flowmap._lastdeleted.md)<!-- -->, and notifies subscribers of the change.
+Removes the key from the internal map, emits the deleted key and its value via [FlowMap.$lastDeleted](./picoflow.flowmap._lastdeleted.md)<!-- -->, and notifies all subscribers of the change.
 

package/api/doc/picoflow.flowmap.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md)
 
 ## FlowMap class
 
-Represents a reactive map of states that extends [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
+Represents a reactive map of states extending [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
 
 **Signature:**
 
@@ -15,13 +15,11 @@ export declare class FlowMap<K, V> extends FlowState<Map<K, V>>
 
 ## Remarks
 
-FlowMap wraps a native Map and provides reactive signals for fine-grained tracking of updates to the map. In addition to the reactive capabilities inherited from FlowState, it exposes two public signals:
+FlowMap wraps a native Map and provides reactive signals for fine-grained tracking of updates to the map. In addition to the reactive capabilities inherited from FlowState, it exposes two reactive signals:
 
-\*\*$lastSet\*\*: A FlowState that holds the most recent key-value pair that was set.
+• $lastSet: Holds the most recent key-value pair that was set. • $lastDeleted: Holds the most recent key-value pair that was deleted.
 
-\*\*$lastDeleted\*\*: A FlowState that holds the most recent key-value pair that was deleted.
-
-Use [FlowMap.setAt()](./picoflow.flowmap.setat.md) to set a key-value pair and [FlowMap.delete()](./picoflow.flowmap.delete.md) to remove a key.
+Use [FlowMap.setAt()](./picoflow.flowmap.setat.md) to add or update a key-value pair and [FlowMap.delete()](./picoflow.flowmap.delete.md) to remove a key.
 
 ## Properties
 

package/api/doc/picoflow.flowmap.setat.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [setAt](./picoflow.flowmap.setat.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [setAt](./picoflow.flowmap.setat.md)
 
 ## FlowMap.setAt() method
 
@@ -67,7 +67,11 @@ The value to set.
 
 void
 
+## Exceptions
+
+If the FlowMap instance is disposed.
+
 ## Remarks
 
-This method updates the internal map with the given key and value, emits the new key-value pair via [FlowMap.$lastSet](./picoflow.flowmap._lastset.md)<!-- -->, and notifies subscribers of the change.
+Updates the internal map, emits the key-value pair via [FlowMap.$lastSet](./picoflow.flowmap._lastset.md)<!-- -->, and notifies all subscribers of the change.
 

package/api/doc/picoflow.flowobservable.get.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md) &gt; [get](./picoflow.flowobservable.get.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md) &gt; [get](./picoflow.flowobservable.get.md)
 
 ## FlowObservable.get() method
 
-Retrieves the current value of the observable.
+Retrieves the current value stored in the observable. Subclasses must override this method to provide the current value.
 
 **Signature:**
 
@@ -15,5 +15,5 @@ abstract get(): T;
 
 T
 
-The current value.
+The current value of type T.
 

package/api/doc/picoflow.flowobservable.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md)
 
 ## FlowObservable class
 
-Represents a reactive observable that carries a value.
+Represents a reactive observable that holds and tracks a value.
 
 **Signature:**
 
@@ -15,7 +15,7 @@ export declare abstract class FlowObservable<T> extends FlowSignal
 
 ## Remarks
 
-A FlowObservable extends the basic FlowSignal to store a value. Subclasses must implement the abstract [FlowObservable.get()](./picoflow.flowobservable.get.md) method to return the current value.
+Subclasses must implement the [FlowObservable.get()](./picoflow.flowobservable.get.md) method to return the current value.
 
 ## Methods
 
@@ -47,7 +47,21 @@ Description
 
 </td><td>
 
-Retrieves the current value of the observable.
+Retrieves the current value stored in the observable. Subclasses must override this method to provide the current value.
+
+
+</td></tr>
+<tr><td>
+
+[subscribe(listener)](./picoflow.flowobservable.subscribe.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Subscribes a listener function to changes of the observable. The listener is executed immediately with the current value and on subsequent updates.
 
 
 </td></tr>

package/api/doc/picoflow.flowobservable.subscribe.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md) &gt; [subscribe](./picoflow.flowobservable.subscribe.md)
+
+## FlowObservable.subscribe() method
+
+Subscribes a listener function to changes of the observable. The listener is executed immediately with the current value and on subsequent updates.
+
+**Signature:**
+
+```typescript
+subscribe(listener: (value: T) => void): () => void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+listener
+
+
+</td><td>
+
+(value: T) =&gt; void
+
+
+</td><td>
+
+A callback function that receives the new value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+() =&gt; void
+
+A disposer function to cancel the subscription.
+

package/api/doc/picoflow.flowresource._constructor_.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [(constructor)](./picoflow.flowresource._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [(constructor)](./picoflow.flowresource._constructor_.md)
 
 ## FlowResource.(constructor)
 
@@ -9,7 +9,7 @@ Creates a new FlowResource.
 **Signature:**
 
 ```typescript
-constructor(fetch: () => Promise<T>, initial: T);
+constructor(fetch: () => Promise<T>);
 ```
 
 ## Parameters
@@ -45,21 +45,5 @@ fetch
 An asynchronous function that retrieves the resource's value.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the resource.
-
-
 </td></tr>
 </tbody></table>

package/api/doc/picoflow.flowresource.fetch.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [fetch](./picoflow.flowresource.fetch.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [fetch](./picoflow.flowresource.fetch.md)
 
 ## FlowResource.fetch() method