@ersbeth/picoflow 0.0.1 → 0.2.0

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.
+

package/api/doc/picoflow.flowstreamasync.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; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [get](./picoflow.flowstreamasync.get.md)
+
+## FlowStreamAsync.get() method
+
+Retrieves the current value of the stream as a Promise.
+
+**Signature:**
+
+```typescript
+get(): Promise<T>;
+```
+**Returns:**
+
+Promise&lt;T&gt;
+
+A Promise that resolves to the current value.
+
+## Exceptions
+
+Error if the stream is disposed.
+

package/api/doc/picoflow.flowstreamasync.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; [FlowStreamAsync](./picoflow.flowstreamasync.md)
+
+## FlowStreamAsync class
+
+Represents an asynchronous reactive stream that updates its value based on an updater function.
+
+**Signature:**
+
+```typescript
+export declare class FlowStreamAsync<T> extends FlowObservable<Promise<T>> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;T&gt;&gt;
+
+## Remarks
+
+A FlowStreamAsync extends FlowObservable and encapsulates a mechanism for asynchronously updating its value. The updater is invoked during construction with a setter, and its returned disposer is called upon disposal. Note: The stream's current value may be undefined until it is set.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(updater)](./picoflow.flowstreamasync._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new asynchronous FlowStream.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dispose()](./picoflow.flowstreamasync.dispose.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Disposes the stream, releasing all resources.
+
+
+</td></tr>
+<tr><td>
+
+[get()](./picoflow.flowstreamasync.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the current value of the stream as a Promise.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowstreamdisposer.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
+
+## FlowStreamDisposer type
+
+A function type that disposes of a resource.
+
+**Signature:**
+
+```typescript
+export type FlowStreamDisposer = () => void;
+```

package/api/doc/picoflow.flowstreamsetter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamSetter](./picoflow.flowstreamsetter.md)
+
+## FlowStreamSetter type
+
+A function type that sets a new value for the reactive stream.
+
+**Signature:**
+
+```typescript
+export type FlowStreamSetter<T> = (value: T) => void;
+```

package/api/doc/picoflow.flowstreamupdater.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamUpdater](./picoflow.flowstreamupdater.md)
+
+## FlowStreamUpdater type
+
+A function type that updates a stream and returns a disposer for cleanup.
+
+**Signature:**
+
+```typescript
+export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDisposer;
+```
+**References:** [FlowStreamSetter](./picoflow.flowstreamsetter.md)<!-- -->, [FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
+
+## Remarks
+
+The updater receives a setter function to update the stream's value. It should return a disposer function to release any resources or subscriptions.
+

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

package/api/doc/picoflow.isdisposable.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; [isDisposable](./picoflow.isdisposable.md)
+
+## isDisposable() function
+
+Checks whether an object implements the FlowDisposable interface.
+
+**Signature:**
+
+```typescript
+export declare function isDisposable(obj: unknown): obj is FlowDisposable;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+unknown
+
+
+</td><td>
+
+The object to test.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+obj is [FlowDisposable](./picoflow.flowdisposable.md)
+
+True if the object has a dispose method, otherwise false.
+

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