@ersbeth/picoflow 0.0.1 → 0.1.0

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,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; [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:**
 
@@ -17,9 +17,5 @@ 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
 
@@ -14,7 +14,7 @@ export declare class FlowSignal
 
 ## 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 +56,7 @@ boolean
 
 </td><td>
 
-Indicates whether the signal has been disposed.
+Indicates whether the FlowSignal has been disposed.
 
 
 </td></tr>
@@ -90,7 +90,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 +104,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.
 

package/api/doc/picoflow.flowstate.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; [FlowState](./picoflow.flowstate.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md)
 
 ## FlowState class
 
@@ -9,47 +9,13 @@ Represents a reactive state that holds a mutable value.
 **Signature:**
 
 ```typescript
-export declare class FlowState<T> extends FlowObservable<T> 
+export declare class FlowState<T> extends FlowConstant<T> 
 ```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+**Extends:** [FlowConstant](./picoflow.flowconstant.md)<!-- -->&lt;T&gt;
 
 ## Remarks
 
-FlowState extends FlowObservable to provide a simple reactive state primitive. Use the [FlowState.get()](./picoflow.flowstate.get.md) method to read the current state and [FlowState.set()](./picoflow.flowstate.set.md) to update it. When the state is updated, subscribers are notified automatically.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(value)](./picoflow.flowstate._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new FlowState with the given initial value.
-
-
-</td></tr>
-</tbody></table>
+FlowState extends FlowConstant, which provides the [FlowConstant.get()](./picoflow.flowconstant.get.md) method to read the current state. Use the [FlowState.set()](./picoflow.flowstate.set.md) method to update the state. When the state is updated, subscribers are notified automatically. This class notifies subscribers only when the value changes.
 
 ## Methods
 
@@ -71,20 +37,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[get()](./picoflow.flowstate.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Retrieves the current state value.
-
-
-</td></tr>
-<tr><td>
-
 [set(value)](./picoflow.flowstate.set.md)
 
 

package/api/doc/picoflow.flowstate.set.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; [FlowState](./picoflow.flowstate.md) &gt; [set](./picoflow.flowstate.set.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [set](./picoflow.flowstate.set.md)
 
 ## FlowState.set() method
 
@@ -9,7 +9,7 @@ Updates the state with a new value.
 **Signature:**
 
 ```typescript
-set(value: T): void;
+set(value: T | ((current: T) => T)): void;
 ```
 
 ## Parameters
@@ -37,12 +37,12 @@ value
 
 </td><td>
 
-T
+T \| ((current: T) =&gt; T)
 
 
 </td><td>
 
-The new value to set.
+A new value or a callback function that computes a new value based on the current state.
 
 
 </td></tr>
@@ -57,5 +57,5 @@ Error if the state has been disposed.
 
 ## Remarks
 
-If the new value is identical to the current value, no update or notification occurs. Otherwise, the state is updated and all subscribers are notified.
+If the computed new value is strictly equal to the current state value, no change is made and subscribers will not be notified. Otherwise, the state is updated and all subscribers are informed of the change.
 

package/api/doc/picoflow.flowstream._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; [FlowStream](./picoflow.flowstream.md) &gt; [(constructor)](./picoflow.flowstream._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [(constructor)](./picoflow.flowstream._constructor_.md)
 
 ## FlowStream.(constructor)
 
@@ -9,7 +9,7 @@ Creates a new FlowStream.
 **Signature:**
 
 ```typescript
-constructor(updater: FlowUpdater<T>, initial: T);
+constructor(updater: FlowStreamUpdater<T>);
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ updater
 
 </td><td>
 
-[FlowUpdater](./picoflow.flowupdater.md)<!-- -->&lt;T&gt;
+[FlowStreamUpdater](./picoflow.flowstreamupdater.md)<!-- -->&lt;T&gt;
 
 
 </td><td>
@@ -45,21 +45,5 @@ updater
 A function that receives a setter to update the stream's value. It should return a disposer function that will be called upon disposal.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the stream.
-
-
 </td></tr>
 </tbody></table>

package/api/doc/picoflow.flowstream.dispose.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; [FlowStream](./picoflow.flowstream.md) &gt; [dispose](./picoflow.flowstream.dispose.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [dispose](./picoflow.flowstream.dispose.md)
 
 ## FlowStream.dispose() method
 

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

package/api/doc/picoflow.flowstream.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; [FlowStream](./picoflow.flowstream.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md)
 
 ## FlowStream class
 
@@ -9,13 +9,13 @@ Represents a reactive stream that updates its value based on an updater function
 **Signature:**
 
 ```typescript
-export declare class FlowStream<T> extends FlowObservable<T> 
+export declare class FlowStream<T> extends FlowObservable<T | undefined> 
 ```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T \| undefined&gt;
 
 ## Remarks
 
-A FlowStream extends FlowObservable and encapsulates a mechanism for updating its value via an external updater function. The updater is invoked during construction with a setter, and it returns a disposer to be called when the stream is disposed.
+FlowStream extends FlowObservable to encapsulate an update mechanism provided by an external updater function. The updater is invoked during construction with a setter, and it returns a disposer to be called upon disposal. Note: The stream's current value may be undefined until explicitly set.
 
 ## Constructors
 
@@ -37,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(updater, initial)](./picoflow.flowstream._constructor_.md)
+[(constructor)(updater)](./picoflow.flowstream._constructor_.md)
 
 
 </td><td>

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

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [(constructor)](./picoflow.flowstreamasync._constructor_.md)
+
+## FlowStreamAsync.(constructor)
+
+Creates a new asynchronous FlowStream.
+
+**Signature:**
+
+```typescript
+constructor(updater: FlowStreamUpdater<T>);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+updater
+
+
+</td><td>
+
+[FlowStreamUpdater](./picoflow.flowstreamupdater.md)<!-- -->&lt;T&gt;
+
+
+</td><td>
+
+A function that receives a setter to update the stream's value. It should return a disposer function that will be called upon disposal.
+
+
+</td></tr>
+</tbody></table>
+
+## Remarks
+
+The updater function can invoke the setter asynchronously to update the stream.
+

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [dispose](./picoflow.flowstreamasync.dispose.md)
+
+## FlowStreamAsync.dispose() method
+
+Disposes the stream, releasing all resources.
+
+**Signature:**
+
+```typescript
+dispose(): void;
+```
+**Returns:**
+
+void
+
+## Remarks
+
+In addition to disposing the underlying observable, this method calls the disposer returned by the updater.
+