@ersbeth/picoflow 0.0.1 → 0.2.0

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
 

package/api/doc/picoflow.flowresource.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; [FlowResource](./picoflow.flowresource.md) &gt; [get](./picoflow.flowresource.get.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [get](./picoflow.flowresource.get.md)
 
 ## FlowResource.get() method
 
@@ -9,13 +9,13 @@ Retrieves the current resource value.
 **Signature:**
 
 ```typescript
-get(): T;
+get(): T | undefined;
 ```
 **Returns:**
 
-T
+T \| undefined
 
-The current value.
+The current value, or undefined if the resource has not been fetched yet.
 
 ## Exceptions
 

package/api/doc/picoflow.flowresource.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)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md)
 
 ## FlowResource class
 
@@ -9,9 +9,9 @@ Represents a reactive resource that asynchronously fetches its value.
 **Signature:**
 
 ```typescript
-export declare class FlowResource<T> extends FlowObservable<T> 
+export declare class FlowResource<T> extends FlowObservable<T | undefined> 
 ```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T \| undefined&gt;
 
 ## Remarks
 
@@ -37,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(fetch, initial)](./picoflow.flowresource._constructor_.md)
+[(constructor)(fetch)](./picoflow.flowresource._constructor_.md)
 
 
 </td><td>

package/api/doc/picoflow.flowresourceasync._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; [FlowResourceAsync](./picoflow.flowresourceasync.md) &gt; [(constructor)](./picoflow.flowresourceasync._constructor_.md)
+
+## FlowResourceAsync.(constructor)
+
+Creates a new FlowResource.
+
+**Signature:**
+
+```typescript
+constructor(fetch: () => Promise<T>);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fetch
+
+
+</td><td>
+
+() =&gt; Promise&lt;T&gt;
+
+
+</td><td>
+
+An asynchronous function that retrieves the resource's value.
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResourceAsync](./picoflow.flowresourceasync.md) &gt; [fetch](./picoflow.flowresourceasync.fetch.md)
+
+## FlowResourceAsync.fetch() method
+
+Asynchronously fetches a new value for the resource.
+
+**Signature:**
+
+```typescript
+fetch(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+
+A Promise that resolves when the fetch operation is complete.
+
+## Exceptions
+
+Error if the resource is disposed.
+
+## Remarks
+
+Executes the internal fetch function. If the fetched value differs from the current one, updates the resource's value and notifies subscribers.
+

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResourceAsync](./picoflow.flowresourceasync.md) &gt; [get](./picoflow.flowresourceasync.get.md)
+
+## FlowResourceAsync.get() method
+
+Retrieves the current resource value.
+
+**Signature:**
+
+```typescript
+get(): Promise<T>;
+```
+**Returns:**
+
+Promise&lt;T&gt;
+
+The current value, or undefined if the resource has not been fetched yet.
+
+## Exceptions
+
+Error if the resource is disposed.
+

package/api/doc/picoflow.flowresourceasync.md

@@ -0,0 +1,100 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResourceAsync](./picoflow.flowresourceasync.md)
+
+## FlowResourceAsync class
+
+Represents a reactive resource that asynchronously fetches its value.
+
+**Signature:**
+
+```typescript
+export declare class FlowResourceAsync<T> extends FlowObservable<Promise<T>> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;T&gt;&gt;
+
+## Remarks
+
+A FlowResource extends FlowObservable and encapsulates an asynchronous fetch function. It is used to retrieve and update its value asynchronously. When the fetch is executed, if the new value differs from the current value, the resource is updated and its subscribers are notified.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(fetch)](./picoflow.flowresourceasync._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowResource.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fetch()](./picoflow.flowresourceasync.fetch.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Asynchronously fetches a new value for the resource.
+
+
+</td></tr>
+<tr><td>
+
+[get()](./picoflow.flowresourceasync.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the current resource value.
+
+
+</td></tr>
+</tbody></table>

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

@@ -1,25 +1,59 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [dispose](./picoflow.flowsignal.dispose.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [dispose](./picoflow.flowsignal.dispose.md)
 
 ## FlowSignal.dispose() method
 
-Disposes the signal.
+Disposes the FlowSignal. Cleans up all registered effects, listeners, and dependencies. Once disposed, further usage of the signal will throw an error.
 
 **Signature:**
 
 ```typescript
-dispose(): void;
+dispose(options?: {
+        self: boolean;
+    }): void;
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+{ self: boolean; }
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void
 
 ## Exceptions
 
-Error if the signal is already disposed.
-
-## Remarks
-
-Disposing a signal will dispose all registered effects and listeners, and unregister all dependencies. Once disposed, any further calls to the signal will throw an error.
+If the FlowSignal is already disposed.
 

package/api/doc/picoflow.flowsignal.disposed.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; [FlowSignal](./picoflow.flowsignal.md) &gt; [disposed](./picoflow.flowsignal.disposed.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [disposed](./picoflow.flowsignal.disposed.md)
 
 ## FlowSignal.disposed property
 
-Indicates whether the signal has been disposed.
+Indicates whether the FlowSignal has been disposed.
 
 **Signature:**
 

package/api/doc/picoflow.flowsignal.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; [FlowSignal](./picoflow.flowsignal.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md)
 
 ## FlowSignal class
 
@@ -9,12 +9,13 @@ Represents a reactive signal.
 **Signature:**
 
 ```typescript
-export declare class FlowSignal 
+export declare class FlowSignal implements FlowDisposable 
 ```
+**Implements:** [FlowDisposable](./picoflow.flowdisposable.md)
 
 ## Remarks
 
-A FlowSignal allows you to trigger notifications via [FlowSignal.trigger()](./picoflow.flowsignal.trigger.md) and to dispose the signal and all its registered dependencies, listeners, and effects via [FlowSignal.dispose()](./picoflow.flowsignal.dispose.md)<!-- -->.
+Use FlowSignal to create reactive streams that notify listeners and execute associated effects. Signals can be triggered and disposed. Once disposed, interactions with the signal will throw errors.
 
 ## Properties
 
@@ -56,7 +57,7 @@ boolean
 
 </td><td>
 
-Indicates whether the signal has been disposed.
+Indicates whether the FlowSignal has been disposed.
 
 
 </td></tr>
@@ -82,7 +83,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[dispose()](./picoflow.flowsignal.dispose.md)
+[dispose(options)](./picoflow.flowsignal.dispose.md)
 
 
 </td><td>
@@ -90,7 +91,7 @@ Description
 
 </td><td>
 
-Disposes the signal.
+Disposes the FlowSignal. Cleans up all registered effects, listeners, and dependencies. Once disposed, further usage of the signal will throw an error.
 
 
 </td></tr>
@@ -104,7 +105,7 @@ Disposes the signal.
 
 </td><td>
 
-Triggers the signal.
+Triggers the FlowSignal. Notifies all registered listeners and schedules execution of associated effects.
 
 
 </td></tr>

package/api/doc/picoflow.flowsignal.trigger.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; [FlowSignal](./picoflow.flowsignal.md) &gt; [trigger](./picoflow.flowsignal.trigger.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [trigger](./picoflow.flowsignal.trigger.md)
 
 ## FlowSignal.trigger() method
 
-Triggers the signal.
+Triggers the FlowSignal. Notifies all registered listeners and schedules execution of associated effects.
 
 **Signature:**
 
@@ -17,9 +17,5 @@ void
 
 ## Exceptions
 
-Error if the signal is disposed.
-
-## Remarks
-
-This method notifies all registered listeners and causes associated effects to execute.
+If the FlowSignal has already been disposed.