@ersbeth/picoflow 0.0.1 → 0.1.0

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

package/api/doc/picoflow.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md)
 
 ## picoflow package
 
@@ -21,6 +21,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[FlowConstant](./picoflow.flowconstant.md)
+
+
+</td><td>
+
+Represents a reactive and immutable constant value computed lazily upon first access.
+
+
+</td></tr>
+<tr><td>
+
 [FlowDerivation](./picoflow.flowderivation.md)
 
 
@@ -37,7 +48,7 @@ Represents a reactive derivation whose value is computed based on other reactive
 
 </td><td>
 
-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.
 
 
 </td></tr>
@@ -48,7 +59,7 @@ Represents a reactive effect that executes a side‐effect function based on its
 
 </td><td>
 
-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.
 
 
 </td></tr>
@@ -62,6 +73,17 @@ Represents a reactive map of states that extends [FlowState](./picoflow.flowstat
 Represents a reactive resource that asynchronously fetches its value.
 
 
+</td></tr>
+<tr><td>
+
+[FlowResourceAsync](./picoflow.flowresourceasync.md)
+
+
+</td><td>
+
+Represents a reactive resource that asynchronously fetches its value.
+
+
 </td></tr>
 <tr><td>
 
@@ -95,6 +117,17 @@ Represents a reactive state that holds a mutable value.
 Represents a reactive stream that updates its value based on an updater function.
 
 
+</td></tr>
+<tr><td>
+
+[FlowStreamAsync](./picoflow.flowstreamasync.md)
+
+
+</td><td>
+
+Represents an asynchronous reactive stream that updates its value based on an updater function.
+
+
 </td></tr>
 </tbody></table>
 
@@ -118,7 +151,7 @@ Description
 
 </td><td>
 
-Represents a reactive observable that carries a value.
+Represents a reactive observable that holds and tracks a value.
 
 
 </td></tr>
@@ -139,6 +172,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[constant(value)](./picoflow.constant.md)
+
+
+</td><td>
+
+Creates a new reactive constant.
+
+
+</td></tr>
+<tr><td>
+
 [derivation(fn)](./picoflow.derivation.md)
 
 
@@ -172,7 +216,7 @@ Creates a new reactive map state.
 </td></tr>
 <tr><td>
 
-[resource(fn, initial)](./picoflow.resource.md)
+[resource(fn)](./picoflow.resource.md)
 
 
 </td><td>
@@ -180,6 +224,17 @@ Creates a new reactive map state.
 Creates a new reactive resource that asynchronously fetches its value.
 
 
+</td></tr>
+<tr><td>
+
+[resourceAsync(fn)](./picoflow.resourceasync.md)
+
+
+</td><td>
+
+Creates a new reactive asynchronous resource that fetches its value.
+
+
 </td></tr>
 <tr><td>
 
@@ -205,7 +260,7 @@ Creates a new reactive state holding a value.
 </td></tr>
 <tr><td>
 
-[stream(updater, initial)](./picoflow.stream.md)
+[stream(updater)](./picoflow.stream.md)
 
 
 </td><td>
@@ -213,6 +268,17 @@ Creates a new reactive state holding a value.
 Creates a new reactive stream.
 
 
+</td></tr>
+<tr><td>
+
+[streamAsync(updater)](./picoflow.streamasync.md)
+
+
+</td><td>
+
+Creates a new reactive asynchronous stream.
+
+
 </td></tr>
 </tbody></table>
 
@@ -231,45 +297,45 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[FlowDisposer](./picoflow.flowdisposer.md)
+[FlowGetter](./picoflow.flowgetter.md)
 
 
 </td><td>
 
-A function that disposes of a resource.
+A function that retrieves the current value from a FlowObservable.
 
 
 </td></tr>
 <tr><td>
 
-[FlowGetter](./picoflow.flowgetter.md)
+[FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
 
 
 </td><td>
 
-A function for retrieving the current value from a FlowObservable.
+A function type that disposes of a resource.
 
 
 </td></tr>
 <tr><td>
 
-[FlowSetter](./picoflow.flowsetter.md)
+[FlowStreamSetter](./picoflow.flowstreamsetter.md)
 
 
 </td><td>
 
-A function that sets a new value.
+A function type that sets a new value for the reactive stream.
 
 
 </td></tr>
 <tr><td>
 
-[FlowUpdater](./picoflow.flowupdater.md)
+[FlowStreamUpdater](./picoflow.flowstreamupdater.md)
 
 
 </td><td>
 
-A function that performs updates on a stream.
+A function type that updates a stream and returns a disposer for cleanup.
 
 
 </td></tr>

package/api/doc/picoflow.resource.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; [resource](./picoflow.resource.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [resource](./picoflow.resource.md)
 
 ## resource() function
 
@@ -9,7 +9,7 @@ Creates a new reactive resource that asynchronously fetches its value.
 **Signature:**
 
 ```typescript
-export declare function resource<T>(fn: () => Promise<T>, initial: T): FlowResource<T>;
+export declare function resource<T>(fn: () => Promise<T>): FlowResource<T>;
 ```
 
 ## Parameters
@@ -45,22 +45,6 @@ fn
 An asynchronous function that fetches the resource value.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the resource.
-
-
 </td></tr>
 </tbody></table>
 **Returns:**

package/api/doc/picoflow.resourceasync.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; [resourceAsync](./picoflow.resourceasync.md)
+
+## resourceAsync() function
+
+Creates a new reactive asynchronous resource that fetches its value.
+
+**Signature:**
+
+```typescript
+export declare function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fn
+
+
+</td><td>
+
+() =&gt; Promise&lt;T&gt;
+
+
+</td><td>
+
+An asynchronous function that fetches the resource value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->.
+

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

package/api/doc/picoflow.state.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; [state](./picoflow.state.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [state](./picoflow.state.md)
 
 ## state() function
 
@@ -9,7 +9,7 @@ Creates a new reactive state holding a value.
 **Signature:**
 
 ```typescript
-export declare function state<T>(value: T): FlowState<T>;
+export declare function state<T>(value: T | (() => T)): FlowState<T>;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ value
 
 </td><td>
 
-T
+T \| (() =&gt; T)
 
 
 </td><td>

package/api/doc/picoflow.stream.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; [stream](./picoflow.stream.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [stream](./picoflow.stream.md)
 
 ## stream() function
 
@@ -9,7 +9,7 @@ Creates a new reactive stream.
 **Signature:**
 
 ```typescript
-export declare function stream<T>(updater: (set: (value: T) => void) => () => void, initial: T): FlowStream<T>;
+export declare function stream<T>(updater: (set: (value: T) => void) => () => void): FlowStream<T>;
 ```
 
 ## Parameters
@@ -45,22 +45,6 @@ updater
 A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the stream.
-
-
 </td></tr>
 </tbody></table>
 **Returns:**

package/api/doc/picoflow.streamasync.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; [streamAsync](./picoflow.streamasync.md)
+
+## streamAsync() function
+
+Creates a new reactive asynchronous stream.
+
+**Signature:**
+
+```typescript
+export declare function streamAsync<T>(updater: (set: (value: T) => void) => () => void): FlowStreamAsync<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+updater
+
+
+</td><td>
+
+(set: (value: T) =&gt; void) =&gt; () =&gt; void
+
+
+</td><td>
+
+A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->.
+